org.axsl.common.value

Enum IndexMerge

java.lang.Object

java.lang.Enum<IndexMerge>

org.axsl.common.value.IndexMerge

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexMerge>

public enum IndexMerge
extends java.lang.Enum<IndexMerge>

An enumeration of possible index merging options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEAVE_SEPARATE Items should be left separate.
MERGE Items should be merged.

Method Summary

Modifier and Type	Method and Description
boolean	isMerge() Indicates whether items should be merged.
static IndexMerge	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IndexMerge[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MERGE

public static final IndexMerge MERGE

Items should be merged.

LEAVE_SEPARATE

public static final IndexMerge LEAVE_SEPARATE

Items should be left separate.

Method Detail

values

public static IndexMerge[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IndexMerge c : IndexMerge.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IndexMerge valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isMerge

public boolean isMerge()

Indicates whether items should be merged.

Returns:

True iff items should be merged.