org.axsl.common.value

Enum RetrievePositionWithinTable

java.lang.Object

java.lang.Enum<RetrievePositionWithinTable>

org.axsl.common.value.RetrievePositionWithinTable

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RetrievePositionWithinTable>

public enum RetrievePositionWithinTable
extends java.lang.Enum<RetrievePositionWithinTable>

Enumeration of possible "retrieve-position-within-table" values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST_INCLUDING_CARRYOVER Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of the primary retrieve scope area, and (2) that precedes in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.
FIRST_STARTING Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of the primary retrieve scope area, (2) whose "is-first" trait is set to "true", and (3) precedes in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.
LAST_ENDING Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of a retrieve scope area, and (2) whose "is-last" trait is set to "true" and that follows in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.
LAST_STARTING Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of a retrieve scope area, (2) whose "is-first" trait is set to "true", and (3) that follows in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.

Method Summary

Modifier and Type	Method and Description
static RetrievePositionWithinTable	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RetrievePositionWithinTable[]	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

FIRST_STARTING

public static final RetrievePositionWithinTable FIRST_STARTING

Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of the primary retrieve scope area, (2) whose "is-first" trait is set to "true", and (3) precedes in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.

FIRST_INCLUDING_CARRYOVER

public static final RetrievePositionWithinTable FIRST_INCLUDING_CARRYOVER

Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of the primary retrieve scope area, and (2) that precedes in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.

LAST_STARTING

public static final RetrievePositionWithinTable LAST_STARTING

Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of a retrieve scope area, (2) whose "is-first" trait is set to "true", and (3) that follows in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.

LAST_ENDING

public static final RetrievePositionWithinTable LAST_ENDING

Specifies a preference for retrieving the children of an fo:marker attached to an area (1) that is a descendant of a retrieve scope area, and (2) whose "is-last" trait is set to "true" and that follows in the area tree, using pre-order traversal order, any other similarly constrained area that has an attached fo:marker with the same value of the "marker-class-name" property.

Method Detail

values

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

Returns:

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

valueOf

public static RetrievePositionWithinTable valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null