com.deltaxml.pipe.filters

Enum LexicalPreservationBase.Region

java.lang.Object

java.lang.Enum<LexicalPreservationBase.Region>

com.deltaxml.pipe.filters.LexicalPreservationBase.Region

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LexicalPreservationBase.Region>

Enclosing class:

LexicalPreservationBase

public static enum LexicalPreservationBase.Region
extends java.lang.Enum<LexicalPreservationBase.Region>

An enumeration marks the region of the document that is being parsed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER_BODY This region marker is used for all content that follows the body of the XML document.
AFTER_DTD This region marker is used for content between the DTD declaration and the body of the XML document.
BEFORE_DTD This region marker is used to define all content before a DOCTYPE declaration (which may contain a DTD or reference an external DTD).
IN_BODY This region marker is used when inside the body of the XML document.
IN_EXT_DTD This region marker is used to identify when an external DTD declaration/file is being processed.
IN_INT_SUBSET This region marker is used to identify when the internal subset is being processed.

Method Summary

Modifier and Type	Method and Description
static LexicalPreservationBase.Region	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LexicalPreservationBase.Region[]	values() Returns an array containing the constants of this enum type, in the order they are 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

BEFORE_DTD

public static final LexicalPreservationBase.Region BEFORE_DTD

This region marker is used to define all content before a DOCTYPE declaration (which may contain a DTD or reference an external DTD). If no DOCTYPE declaration exists. then this region extends to the body of the XML document is encountered.

IN_INT_SUBSET

public static final LexicalPreservationBase.Region IN_INT_SUBSET

This region marker is used to identify when the internal subset is being processed.

IN_EXT_DTD

public static final LexicalPreservationBase.Region IN_EXT_DTD

This region marker is used to identify when an external DTD declaration/file is being processed.

AFTER_DTD

public static final LexicalPreservationBase.Region AFTER_DTD

This region marker is used for content between the DTD declaration and the body of the XML document.

IN_BODY

public static final LexicalPreservationBase.Region IN_BODY

This region marker is used when inside the body of the XML document.

AFTER_BODY

public static final LexicalPreservationBase.Region AFTER_BODY

This region marker is used for all content that follows the body of the XML document.

Method Detail

values

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

Returns:

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

valueOf

public static LexicalPreservationBase.Region 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