Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## org.teleal.lemma.anchor
Enum CitationAnchor.OptionKey

    java.lang.Object
      java.lang.Enum<CitationAnchor.OptionKey>
          org.teleal.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
`CLEAN_LABELS`
`EXCLUDE`
`INCLUDE`
`LTRIM`
`READ_TITLE`
`READER`

Method Summary
`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

### LTRIM

    public static final CitationAnchor.OptionKey LTRIM

### READER

    public static final CitationAnchor.OptionKey READER

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()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

Copyright © 2010 Teleal GmbH, Switzerland. All Rights Reserved.