com.jalios.jcms.search.queryparser

Enum ParseOptions.TextMode

java.lang.Object

java.lang.Enum<ParseOptions.TextMode>

com.jalios.jcms.search.queryparser.ParseOptions.TextMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParseOptions.TextMode>

Enclosing class:

ParseOptions

public static enum ParseOptions.TextMode
extends java.lang.Enum<ParseOptions.TextMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADVANCED The mode value to use to perform a text search with advanced search syntax (wildcard, field, etc).
ALL_WORDS The mode value to use to perform a text search matching all the words of the search string.
ANY_WORD The mode value to use to perform a text search matching at least one of the words of the search string.
EXACT The mode value to use to perform a text search matching the exact phrase specified in the search string.

Method Summary

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

ALL_WORDS

public static final ParseOptions.TextMode ALL_WORDS

The mode value to use to perform a text search matching all the words of the search string.

Since:

jcms-6.1.0

ANY_WORD

public static final ParseOptions.TextMode ANY_WORD

The mode value to use to perform a text search matching at least one of the words of the search string.

Since:

jcms-6.1.0

EXACT

public static final ParseOptions.TextMode EXACT

The mode value to use to perform a text search matching the exact phrase specified in the search string.

Since:

jcms-6.1.0

ADVANCED

public static final ParseOptions.TextMode ADVANCED

The mode value to use to perform a text search with advanced search syntax (wildcard, field, etc).

Since:

jcms-6.1.0

Method Detail

values

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

Returns:

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

valueOf

public static ParseOptions.TextMode 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