sirius.db.es.annotations

Enum ESOption

java.lang.Object

java.lang.Enum<ESOption>

sirius.db.es.annotations.ESOption

All Implemented Interfaces:

Serializable, Comparable<ESOption>

public enum ESOption
extends Enum<ESOption>

Used to describe a tri-state property which is either true, false or default, which will use the default value used by Elasticsearch.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ES_DEFAULT Specifies no value to elasticsearch, hence using the default value of elasticserach
FALSE Specifies false to elasticsearch as the value for this option
TRUE Specifies true to elasticsearch as the value for this option

Method Summary

Modifier and Type	Method and Description
String	toString()
static ESOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static ESOption[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final ESOption TRUE

Specifies true to elasticsearch as the value for this option

FALSE

public static final ESOption FALSE

Specifies false to elasticsearch as the value for this option

ES_DEFAULT

public static final ESOption ES_DEFAULT

Specifies no value to elasticsearch, hence using the default value of elasticserach

Method Detail

values

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

Returns:

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

valueOf

public static ESOption valueOf(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:

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

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ESOption>