Package org.basex.util.ft

Enum Class FTMode

java.lang.Object

java.lang.Enum<FTMode>

org.basex.util.ft.FTMode

All Implemented Interfaces:

Serializable, Comparable<FTMode>, java.lang.constant.Constable

public enum FTMode
extends Enum<FTMode>

Search mode.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All option.
ALL_WORDS	All words option.
ANY	Any option.
ANY_WORD	Any word option.
PHRASE	Phrase search.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final FTMode ALL

All option.

ALL_WORDS

public static final FTMode ALL_WORDS

All words option.

ANY

public static final FTMode ANY

Any option.

ANY_WORD

public static final FTMode ANY_WORD

Any word option.

PHRASE

public static final FTMode PHRASE

Phrase search.

Method Details

values

public static FTMode[] 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 FTMode 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

toString

public String toString()

Overrides:

toString in class Enum<FTMode>