org.pageseeder.bridge.model

Enum PSXRef.TYPE

java.lang.Object

java.lang.Enum<PSXRef.TYPE>

org.pageseeder.bridge.model.PSXRef.TYPE

All Implemented Interfaces:

Serializable, Comparable<PSXRef.TYPE>

Enclosing class:

PSXRef

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

XRef type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMBED embed
IMAGE image
NONE none
TRANSCLUDE transclude

Method Summary

Methods

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

NONE

public static final PSXRef.TYPE NONE

none

EMBED

public static final PSXRef.TYPE EMBED

embed

TRANSCLUDE

public static final PSXRef.TYPE TRANSCLUDE

transclude

IMAGE

public static final PSXRef.TYPE IMAGE

image

Method Detail

values

public static PSXRef.TYPE[] 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.TYPE c : PSXRef.TYPE.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.TYPE 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.TYPE fromString(String value)

Create the type from a string.

Parameters:

value - the string value

Returns:

the type

toString

public String toString()

Convert the type to a string.

Overrides:

toString in class Enum<PSXRef.TYPE>

Returns:

the string