com.canto.cumulus.constants

Enum CombineMode

java.lang.Object

java.lang.Enum<CombineMode>

com.canto.cumulus.constants.CombineMode

All Implemented Interfaces:

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

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

This enum specifies the options for combining a new search result with the existing collection.

Since:

8.0

See Also:

ItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale), MultiItemCollection.find(String, java.util.EnumSet, CombineMode, java.util.Locale)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIND_BROADEN Extend the current collection with the search result.
FIND_NARROW Search within the current collection.
FIND_NEW Replace the current collection content completely with the search result.

Method Summary

Methods

Modifier and Type	Method and Description
static CombineMode	find(int id) Finds the combine mode for the given id.
int	getID() Returns the id for this combine mode.
static CombineMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CombineMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIND_NEW

public static final CombineMode FIND_NEW

Replace the current collection content completely with the search result.

FIND_NARROW

public static final CombineMode FIND_NARROW

Search within the current collection. This is the intersection of the current collection and the search result.

FIND_BROADEN

public static final CombineMode FIND_BROADEN

Extend the current collection with the search result. This is the union of the current collection and the search result.

Method Detail

values

public static CombineMode[] 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 (CombineMode c : CombineMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static CombineMode 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

getID

public int getID()

Returns the id for this combine mode.

Returns:

id

See Also:

find(int)

find

public static CombineMode find(int id)

Finds the combine mode for the given id.

Parameters:

id - wanted id

Returns:

found combine mode or throws an EnumConstantNotPresentException if the id cannot be found

See Also:

getID()