SourceForge.net Logo
aXSL API 0.2

org.axsl.common.value
Enum RetrieveBoundary

java.lang.Object
  extended by java.lang.Enum<RetrieveBoundary>
      extended by 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
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
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're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, 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 final RetrieveBoundary[] values()
Returns an array containing the constants of this enum type, in the order they're 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're 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

SourceForge.net Logo
aXSL API 0.2

This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.