org.axsl.common.value

Enum WhiteSpaceTreatment

java.lang.Object

java.lang.Enum<WhiteSpaceTreatment>

org.axsl.common.value.WhiteSpaceTreatment

All Implemented Interfaces:

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

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

Enumeration of possible white-space-treatment values.

See Also:

"XSL-FO, 1.1, Section 7.16.8 (page 323)."

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE Any character classified as white space, except U+000A (linefeed) shall be deleted.
IGNORE_IF_AFTER_LINEFEED Any character with a suppress-at-line-break value of "suppress" shall be deleted if it would be the first character in the line.
IGNORE_IF_BEFORE_LINEFEED Any character with a suppress-at-line-break value of "suppress" shall be deleted if it would be the last character in the line.
IGNORE_IF_SURROUNDING_LINEFEED Any character with a suppress-at-line-break value of "suppress" shall be deleted if it would be the first or last character in the line.
PRESERVE Any character classified as white space shall not be deleted.

Method Summary

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

IGNORE

public static final WhiteSpaceTreatment IGNORE

Any character classified as white space, except U+000A (linefeed) shall be deleted.

PRESERVE

public static final WhiteSpaceTreatment PRESERVE

Any character classified as white space shall not be deleted.

IGNORE_IF_BEFORE_LINEFEED

public static final WhiteSpaceTreatment IGNORE_IF_BEFORE_LINEFEED

Any character with a suppress-at-line-break value of "suppress" shall be deleted if it would be the last character in the line.

IGNORE_IF_AFTER_LINEFEED

public static final WhiteSpaceTreatment IGNORE_IF_AFTER_LINEFEED

Any character with a suppress-at-line-break value of "suppress" shall be deleted if it would be the first character in the line.

IGNORE_IF_SURROUNDING_LINEFEED

public static final WhiteSpaceTreatment IGNORE_IF_SURROUNDING_LINEFEED

Any character with a suppress-at-line-break value of "suppress" shall be deleted if it would be the first or last character in the line.

Method Detail

values

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

Returns:

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

valueOf

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