org.basex.query.ft
Enum FTMode

java.lang.Object
  extended by java.lang.Enum<FTMode>
      extended by org.basex.query.ft.FTMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FTMode>

public enum FTMode
extends java.lang.Enum<FTMode>

Search mode.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Enum Constant Summary
ALL
          All option.
ALL_WORDS
          All words option.
ANY
          Any option.
ANY_WORD
          Any words option.
PHRASE
          Phrase search.
 
Method Summary
static FTMode get(byte[] mode)
          Returns the specified mode, or null.
static FTMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FTMode[] 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

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 words option.


PHRASE

public static final FTMode PHRASE
Phrase search.

Method Detail

values

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

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

valueOf

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

get

public static FTMode get(byte[] mode)
Returns the specified mode, or null.

Parameters:
mode - mode
Returns:
mode enumeration