org.axsl.common.value

Enum RetrievePosition

java.lang.Object

java.lang.Enum<RetrievePosition>

org.axsl.common.value.RetrievePosition

All Implemented Interfaces:

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

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

Enumeration of the various positions from which a marker can be retrieved.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST_INCLUDING_CARRYOVER Specifies that the marker attached to the earliest area that is on this page and having a marker should be used, even if the area does not start on this page.
FIRST_STARTING_WITHIN_PAGE Specifies that the first marker attached to an area that starts on the page should be used.
LAST_ENDING_WITHIN_PAGE Specifies that the last marker attached to an area that ends on the page should be used.
LAST_STARTING_WITHIN_PAGE Specifies that the last marker attached to an area that starts on the page should be used.

Method Summary

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

public static final RetrievePosition FIRST_STARTING_WITHIN_PAGE

Specifies that the first marker attached to an area that starts on the page should be used.

FIRST_INCLUDING_CARRYOVER

public static final RetrievePosition FIRST_INCLUDING_CARRYOVER

Specifies that the marker attached to the earliest area that is on this page and having a marker should be used, even if the area does not start on this page.

LAST_STARTING_WITHIN_PAGE

public static final RetrievePosition LAST_STARTING_WITHIN_PAGE

Specifies that the last marker attached to an area that starts on the page should be used.

LAST_ENDING_WITHIN_PAGE

public static final RetrievePosition LAST_ENDING_WITHIN_PAGE

Specifies that the last marker attached to an area that ends on the page should be used.

Method Detail

values

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

Returns:

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

valueOf

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