SourceForge.net Logo
aXSL API 0.2

org.axsl.common.value
Enum Break

java.lang.Object
  extended by java.lang.Enum<Break>
      extended by org.axsl.common.value.Break
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Break>

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

Enumeration of the various "break" options.


Enum Constant Summary
AUTO
          No break shall be forced.
COLUMN
          Imposes a break condition within the context of a column.
EVEN_PAGE
          Imposes a break condition within the context of even pages.
ODD_PAGE
          Imposes a break condition within the context of odd pages.
PAGE
          Imposes a break condition within the context of pages.
 
Method Summary
static Break valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Break[] 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

AUTO

public static final Break AUTO
No break shall be forced.


COLUMN

public static final Break COLUMN
Imposes a break condition within the context of a column.


PAGE

public static final Break PAGE
Imposes a break condition within the context of pages.


EVEN_PAGE

public static final Break EVEN_PAGE
Imposes a break condition within the context of even pages. A blank page may be generated if necessary.


ODD_PAGE

public static final Break ODD_PAGE
Imposes a break condition within the context of odd pages. A blank page may be generated if necessary.

Method Detail

values

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

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static Break 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.