edu.northwestern.at.monk.model
Enum MainKind

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

All Implemented Interfaces:

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

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

A main text kind.

See Also:

MONK Datastore Overview, Licensing Agreement

Enum Constant Summary

ALL_TEXT
All text.

MAIN_TEXT
Only main text (non-paratext).

Method Summary

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

ALL_TEXT

public static final MainKind ALL_TEXT

All text.

MAIN_TEXT

public static final MainKind MAIN_TEXT

Only main text (non-paratext).

Method Detail

values

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

Returns:

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

valueOf

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