edu.northwestern.at.monk.model
Enum WordClass.SortOption

java.lang.Object
  extended by java.lang.Enum<WordClass.SortOption>
      extended by edu.northwestern.at.monk.model.WordClass.SortOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<WordClass.SortOption>
Enclosing class:
WordClass

public static enum WordClass.SortOption
extends java.lang.Enum<WordClass.SortOption>

Word class sorting options.


Enum Constant Summary
MAJOR_WORD_CLASS_ASCENDING
          Major word class ascending.
MAJOR_WORD_CLASS_DESCENDING
          Major word class descending.
NATURAL
          The natural sorting order - by tag ascending.
TAG_ASCENDING
          Tag ascending.
TAG_DESCENDING
          Tag descending.
 
Method Summary
static WordClass.SortOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static WordClass.SortOption[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NATURAL

public static final WordClass.SortOption NATURAL
The natural sorting order - by tag ascending.


TAG_ASCENDING

public static final WordClass.SortOption TAG_ASCENDING
Tag ascending.


TAG_DESCENDING

public static final WordClass.SortOption TAG_DESCENDING
Tag descending.


MAJOR_WORD_CLASS_ASCENDING

public static final WordClass.SortOption MAJOR_WORD_CLASS_ASCENDING
Major word class ascending.


MAJOR_WORD_CLASS_DESCENDING

public static final WordClass.SortOption MAJOR_WORD_CLASS_DESCENDING
Major word class descending.

Method Detail

values

public static final WordClass.SortOption[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(WordClass.SortOption c : WordClass.SortOption.values())
        System.out.println(c);

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

valueOf

public static WordClass.SortOption 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