org.foray.fotree.axsl
Enum AxslObject

java.lang.Object
  java.lang.Enum<AxslObject>
      org.foray.fotree.axsl.AxslObject

All Implemented Interfaces:

Serializable, Comparable<AxslObject>

public enum AxslObject
extends Enum<AxslObject>

An enumeration for object extensions to the XSL-FO standard. These objects live in the "axsl" namespace.

Enum Constant Summary

METADATA
Constant indicating a "metadata" FO.

Method Summary

static AxslObject	extensionValueOf(String name) Similar to the Java 1.5 Enum valueOf(String) method, but operates on the XSL-FO name of the object instead of its enumerated name.
String	toExtensionName() Converts an object name enumeration to its name.
static AxslObject	valueOf(String name) Returns the enum constant of this type with the specified name.
static AxslObject[]	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

METADATA

public static final AxslObject METADATA

Constant indicating a "metadata" FO.

Method Detail

values

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

Returns:

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

valueOf

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

toExtensionName

public String toExtensionName()

Converts an object name enumeration to its name. For example, the enumeration METADATA converts to the name "metadata".

Returns:

The name for the object enumeration.

extensionValueOf

public static AxslObject extensionValueOf(String name)

Similar to the Java 1.5 Enum valueOf(String) method, but operates on the XSL-FO name of the object instead of its enumerated name. For example, suppose an enum for "continued-label", that is named CONTINUED_LABEL. The Java 1.5 Enum valueOf(String) method would operate on the enum name "CONTINUED_LABEL". This method instead operates on "continued-label".

Parameters:

name - The name of the XSL-FO object for which the enumerated value is needed.

Returns:

The enumerated value for xslName.