com.attivio.sdk.search

Enum QueryRequest.SpellCheckMode

java.lang.Object

java.lang.Enum<QueryRequest.SpellCheckMode>

com.attivio.sdk.search.QueryRequest.SpellCheckMode

All Implemented Interfaces:

Serializable, Comparable<QueryRequest.SpellCheckMode>

Enclosing class:

QueryRequest

public static enum QueryRequest.SpellCheckMode
extends Enum<QueryRequest.SpellCheckMode>

Modes for spell checking.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_CORRECT The 'auto-correct' mode
AUTO_EXPAND The 'auto-expand' mode
OFF The 'off' mode
SUGGEST The 'suggest' mode

Method Summary

Modifier and Type	Method and Description
static QueryRequest.SpellCheckMode	fromExternal(String value) Converts an external value to a type value
static QueryRequest.SpellCheckMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryRequest.SpellCheckMode[]	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

OFF

public static final QueryRequest.SpellCheckMode OFF

The 'off' mode

SUGGEST

public static final QueryRequest.SpellCheckMode SUGGEST

The 'suggest' mode

AUTO_CORRECT

public static final QueryRequest.SpellCheckMode AUTO_CORRECT

The 'auto-correct' mode

AUTO_EXPAND

public static final QueryRequest.SpellCheckMode AUTO_EXPAND

The 'auto-expand' mode

Method Detail

values

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

Returns:

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

valueOf

public static QueryRequest.SpellCheckMode 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

fromExternal

public static QueryRequest.SpellCheckMode fromExternal(String value)

Converts an external value to a type value

Parameters:

value - the external value

Returns:

the type