org.axsl.common.value

Enum RetrieveBoundary

java.lang.Object

java.lang.Enum<RetrieveBoundary>

org.axsl.common.value.RetrieveBoundary

All Implemented Interfaces:

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

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

Enumeration of the possible values for the boundary within which a marker should be selected.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENT Specifies that any marker in any flow in the document may be retrieved.
PAGE Specifies that only markers whose parent generated or returned a normal area within the containing page may be retrieved.
PAGE_SEQUENCE Specifies that only markers in any flow in the containing page-sequence may be retrieved.

Method Summary

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

PAGE

public static final RetrieveBoundary PAGE

Specifies that only markers whose parent generated or returned a normal area within the containing page may be retrieved.

PAGE_SEQUENCE

public static final RetrieveBoundary PAGE_SEQUENCE

Specifies that only markers in any flow in the containing page-sequence may be retrieved.

DOCUMENT

public static final RetrieveBoundary DOCUMENT

Specifies that any marker in any flow in the document may be retrieved.

Method Detail

values

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

Returns:

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

valueOf

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