edu.northwestern.at.monk.model
Enum Arity

java.lang.Object
  java.lang.Enum<Arity>
      edu.northwestern.at.monk.model.Arity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Arity>

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

An arity (unigram, bigram, or trigram).

See Also:

MONK Datastore Overview, Licensing Agreement

Enum Constant Summary

BIGRAM
Bigram.

TRIGRAM
Trigram.

UNIGRAM
Unigram.

Method Summary

static Arity	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Arity[]	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

UNIGRAM

public static final Arity UNIGRAM

Unigram.

BIGRAM

public static final Arity BIGRAM

Bigram.

TRIGRAM

public static final Arity TRIGRAM

Trigram.

Method Detail

values

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

Returns:

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

valueOf

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