io.vertigo.dynamox.search.dsl.model

Enum DslTermQuery.EscapeMode

java.lang.Object

java.lang.Enum<DslTermQuery.EscapeMode>

io.vertigo.dynamox.search.dsl.model.DslTermQuery.EscapeMode

All Implemented Interfaces:

Serializable, Comparable<DslTermQuery.EscapeMode>

Enclosing class:

DslTermQuery

public static enum DslTermQuery.EscapeMode
extends Enum<DslTermQuery.EscapeMode>

Reserved mode. reserved: + - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ / AND OR

Enum Constant Summary

Enum Constants

Enum Constant and Description
escape escape reserved syntax.
none no change.
remove remove reserved syntax.

Method Summary

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

none

public static final DslTermQuery.EscapeMode none

no change.

escape

public static final DslTermQuery.EscapeMode escape

escape reserved syntax.

remove

public static final DslTermQuery.EscapeMode remove

remove reserved syntax.

Method Detail

values

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

Returns:

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

valueOf

public static DslTermQuery.EscapeMode 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