org.pageseeder.bridge.model

Enum PSXRef.DISPLAY

java.lang.Object

java.lang.Enum<PSXRef.DISPLAY>

org.pageseeder.bridge.model.PSXRef.DISPLAY

All Implemented Interfaces:

Serializable, Comparable<PSXRef.DISPLAY>

Enclosing class:

PSXRef

public static enum PSXRef.DISPLAY
extends Enum<PSXRef.DISPLAY>

XRef titles to display.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENT document
DOCUMENT_FRAGMENT document+fragment
DOCUMENT_MANUAL document+manual.
MANUAL manual

Method Summary

Methods

Modifier and Type	Method and Description
static PSXRef.DISPLAY	fromString(String value) Create the display from a string.
String	toString() Convert the display to a string.
static PSXRef.DISPLAY	valueOf(String name) Returns the enum constant of this type with the specified name.
static PSXRef.DISPLAY[]	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

MANUAL

public static final PSXRef.DISPLAY MANUAL

manual

DOCUMENT

public static final PSXRef.DISPLAY DOCUMENT

document

DOCUMENT_FRAGMENT

public static final PSXRef.DISPLAY DOCUMENT_FRAGMENT

document+fragment

DOCUMENT_MANUAL

public static final PSXRef.DISPLAY DOCUMENT_MANUAL

document+manual.

Method Detail

values

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

Returns:

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

valueOf

public static PSXRef.DISPLAY 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

fromString

public static PSXRef.DISPLAY fromString(String value)

Create the display from a string.

Parameters:

value - the string value

Returns:

the display

toString

public String toString()

Convert the display to a string.

Overrides:

toString in class Enum<PSXRef.DISPLAY>

Returns:

the string