org.fourthline.lemma.anchor

Enum CitationAnchor.OptionKey

java.lang.Object

java.lang.Enum<CitationAnchor.OptionKey>

org.fourthline.lemma.anchor.CitationAnchor.OptionKey

All Implemented Interfaces:

Serializable, Comparable<CitationAnchor.OptionKey>

Enclosing class:

CitationAnchor

public static enum CitationAnchor.OptionKey
extends Enum<CitationAnchor.OptionKey>

The most common option (keys) of citation anchors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALLOUTS
CLEAN_LABELS
DOTS
EXCLUDE
FILEPATH
INCLUDE
LINE_TRIM
LTRIM
PRETTY
READ_TITLE
READER

Method Summary

Modifier and Type	Method and Description
String	getKey()
static CitationAnchor.OptionKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static CitationAnchor.OptionKey[]	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

READ_TITLE

public static final CitationAnchor.OptionKey READ_TITLE

INCLUDE

public static final CitationAnchor.OptionKey INCLUDE

EXCLUDE

public static final CitationAnchor.OptionKey EXCLUDE

CLEAN_LABELS

public static final CitationAnchor.OptionKey CLEAN_LABELS

LINE_TRIM

public static final CitationAnchor.OptionKey LINE_TRIM

LTRIM

public static final CitationAnchor.OptionKey LTRIM

DOTS

public static final CitationAnchor.OptionKey DOTS

FILEPATH

public static final CitationAnchor.OptionKey FILEPATH

READER

public static final CitationAnchor.OptionKey READER

PRETTY

public static final CitationAnchor.OptionKey PRETTY

CALLOUTS

public static final CitationAnchor.OptionKey CALLOUTS

Method Detail

values

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

Returns:

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

valueOf

public static CitationAnchor.OptionKey valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()