de.undercouch.citeproc.csl

Enum CSLLabel

java.lang.Object

java.lang.Enum<CSLLabel>

de.undercouch.citeproc.csl.CSLLabel

All Implemented Interfaces:

Serializable, Comparable<CSLLabel>

public enum CSLLabel
extends Enum<CSLLabel>

Valid citation labels

Author:

Michel Kraemer

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOK
CHAPTER
COLUMN
FIGURE
FOLIO
ISSUE
LINE
NOTE
OPUS
PAGE
PARAGRAPH
PART
SECTION
SUB_VERBO
VERSE
VOLUME

Method Summary

Modifier and Type	Method and Description
static CSLLabel	fromString(String str) Converts the given string to a CSLLabel
String	toString()
static CSLLabel	valueOf(String name) Returns the enum constant of this type with the specified name.
static CSLLabel[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOK

public static final CSLLabel BOOK

CHAPTER

public static final CSLLabel CHAPTER

COLUMN

public static final CSLLabel COLUMN

FIGURE

public static final CSLLabel FIGURE

FOLIO

public static final CSLLabel FOLIO

ISSUE

public static final CSLLabel ISSUE

LINE

public static final CSLLabel LINE

NOTE

public static final CSLLabel NOTE

OPUS

public static final CSLLabel OPUS

PAGE

public static final CSLLabel PAGE

PARAGRAPH

public static final CSLLabel PARAGRAPH

PART

public static final CSLLabel PART

SECTION

public static final CSLLabel SECTION

SUB_VERBO

public static final CSLLabel SUB_VERBO

VERSE

public static final CSLLabel VERSE

VOLUME

public static final CSLLabel VOLUME

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<CSLLabel>

fromString

public static CSLLabel fromString(String str)

Converts the given string to a CSLLabel

Parameters:

str - the string

Returns:

the converted CSLLabel