Package org.jdom2.output
Enum Class Format.TextMode
- All Implemented Interfaces:
Serializable
,Comparable<Format.TextMode>
,Constable
- Enclosing class:
Format
Class to signify how text should be handled on output. The following
table provides details.
In most cases textual content is aligned with the surrounding tags
(after the appropriate text mode is applied). In the case where the only
content between the start and end tags is textual, the start tag, text,
and end tag are all printed on the same line. If the document being
output already has whitespace, it's wise to turn on TRIM mode so the
pre-existing whitespace can be trimmed before adding new whitespace.
Text Mode | Resulting behavior. |
---|---|
PRESERVE (Default) | All content is printed in the format it was created, no whitespace or line separators are are added or removed. |
TRIM_FULL_WHITE | Content between tags consisting of all whitespace is not printed. If the content contains even one non-whitespace character, it is all printed verbatim, whitespace and all. |
TRIM | All leading and trailing whitespace is trimmed. |
NORMALIZE | Leading and trailing whitespace is trimmed, and any 'internal' whitespace is compressed to a single space. |
When an element has a xml:space attribute with the value of "preserve",
all formatting is turned off (actually, the TextMode is set to
PRESERVE
until the element and its contents have been printed.
If a nested element contains another xml:space with the value "default"
formatting is turned back on for the child element and then off for the
remainder of the parent element.
- Since:
- JDOM2
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionMode for text normalization (left and right trim plus internal whitespace is normalized to a single space.Mode for literal text preservation.Mode for text trimming (left and right trim).Mode for text trimming of content consisting of nothing but whitespace but otherwise not changing output. -
Method Summary
Modifier and TypeMethodDescriptionstatic Format.TextMode
Returns the enum constant of this class with the specified name.static Format.TextMode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
PRESERVE
Mode for literal text preservation. -
TRIM
Mode for text trimming (left and right trim). -
NORMALIZE
Mode for text normalization (left and right trim plus internal whitespace is normalized to a single space.- See Also:
-
TRIM_FULL_WHITE
Mode for text trimming of content consisting of nothing but whitespace but otherwise not changing output.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-