Package de.undercouch.citeproc

Enum SelectionMode

java.lang.Object

java.lang.Enum<SelectionMode>

de.undercouch.citeproc.SelectionMode

All Implemented Interfaces:

Serializable, Comparable<SelectionMode>

public enum SelectionMode
extends Enum<SelectionMode>

Selection modes for CSL.makeBibliography(SelectionMode, de.undercouch.citeproc.csl.CSLItemData[]).

Author:

Michel Kraemer

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE
INCLUDE
SELECT

Method Summary

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

SELECT

public static final SelectionMode SELECT

INCLUDE

public static final SelectionMode INCLUDE

EXCLUDE

public static final SelectionMode EXCLUDE

Method Detail

values

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

Returns:

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

valueOf

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

fromString

public static SelectionMode fromString(String str)

Converts the given string to a SelectionMode

Parameters:

str - the string

Returns:

the converted SelectionMode