org.basex.util.ft
Enum FTUnit

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

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

Full-text units.

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

Enum Constant Summary
PARAGRAPH
          Paragraph unit.
SENTENCE
          Sentence unit.
WORD
          Word unit.
 
Method Summary
 java.lang.String toString()
          Returns a string representation.
static FTUnit valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FTUnit[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

WORD

public static final FTUnit WORD
Word unit.


SENTENCE

public static final FTUnit SENTENCE
Sentence unit.


PARAGRAPH

public static final FTUnit PARAGRAPH
Paragraph unit.

Method Detail

values

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

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

valueOf

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

toString

public java.lang.String toString()
Returns a string representation.

Overrides:
toString in class java.lang.Enum<FTUnit>
Returns:
string representation