Enum Class SearchCollectionType

java.lang.Object

java.lang.Enum<SearchCollectionType>

io.fluxzero.common.api.search.SearchCollectionType

All Implemented Interfaces:

Serializable, Comparable<SearchCollectionType>, Constable

public enum SearchCollectionType
extends Enum<SearchCollectionType>

Supported search collection types.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
auditTrail	A time-partitioned searchable audit trail.
regular	A regular document collection.
unknown	A collection type that is unknown to this SDK version.

Method Summary

Modifier and Type	Method	Description
static SearchCollectionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchCollectionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

regular

public static final SearchCollectionType regular

A regular document collection.

auditTrail

public static final SearchCollectionType auditTrail

A time-partitioned searchable audit trail.

unknown

public static final SearchCollectionType unknown

A collection type that is unknown to this SDK version.

Method Details

values

public static SearchCollectionType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchCollectionType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null