Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Format.DefaultCharsetEscapeStrategy Handles Charsets.
private static class	Format.EscapeStrategy7Bits An EscapeStrategy suitable for 7-bit charsets.
private static class	Format.EscapeStrategy8Bits An EscapeStrategy suitable for 8-bit charsets.
private static class	Format.EscapeStrategyUTF An EscapeStrategy suitable for UTF-8 an UTF-16.
public static enum	Format.TextMode Class to signify how text should be handled on output.

Field Summary

Modifier and Type	Field and Description
private static final EscapeStrategy	Bits7EscapeStrategy An EscapeStrategy suitable for 7-bit charsets
private static final EscapeStrategy	Bits8EscapeStrategy An EscapeStrategy suitable for 8-bit charsets
private static final EscapeStrategy	DefaultEscapeStrategy An EscapeStrategy suitable for 'unknown' charsets
pack-priv String	encoding The encoding format
pack-priv EscapeStrategy	escapeStrategy entity escape logic
pack-priv boolean	expandEmptyElements Whether or not to expand empty elements to <tagName></tagName> - default is `false`
pack-priv boolean	ignoreTrAXEscapingPIs Whether TrAX output escaping disabling/enabling PIs are ignored or processed - default is `false`
pack-priv String	indent The default indent is no spaces (as original document)
pack-priv String	lineSeparator New line separator
pack-priv Format.TextMode	mode text handling mode
pack-priv boolean	omitDeclaration Whether or not to output the XML declaration - default is `false`
pack-priv boolean	omitEncoding Whether or not to output the encoding in the XML declaration - default is `false`
pack-priv boolean	specifiedAttributesOnly Whether Attributes that are defaulted from the DTD or Schema are output.
private static final String	STANDARD_ENCODING standard encoding
private static final String	STANDARD_INDENT standard value to indent by, if we are indenting
private static final String	STANDARD_LINE_SEPARATOR standard string with which to end a line
private static final EscapeStrategy	UTFEscapeStrategy An EscapeStrategy suitable for UTF-8 an UTF-16

Constructor Summary

Access	Constructor and Description
private	Format() Creates a new Format instance with default (raw) behavior.

Method Summary

Modifier and Type	Method and Description
private static final EscapeStrategy	chooseStrategy(String encoding)
public Format	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static final String	Returns: The compacted value compact(String The value to compact. str) Use the XML Specification definition of whitespace to compact the input value.
public static final String	Returns: The value appropriately escaped. escapeAttribute(final EscapeStrategy The EscapeStrategy to query. strategy, final String `String` Attribute value to escape. value) This will take the three pre-defined entities in XML 1.0 ('<', '>', and '&' - used specifically in XML elements) as well as CR/NL, tabs, and Quote characters which require escaping inside Attribute values and converts their character representation to the appropriate entity reference suitable for XML attribute content.
public static final String	Returns: The input value escaped. escapeText(final EscapeStrategy The EscapeStrategy strategy, final String The End-Of-Line sequence to be used (may be null). eol, final String The String to escape value) This will take the three pre-defined entities in XML 1.0 ('<', '>', and '&' - used specifically in XML elements) and convert their character representation to the appropriate entity reference, suitable for XML element content.
public static Format	Returns: a Format with whitespace normalization getCompactFormat() Returns a new Format object that performs whitespace normalization, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.
public String	Returns: the output encoding getEncoding() Returns the configured output encoding.
public EscapeStrategy	Returns: the current escape strategy getEscapeStrategy() Returns the current escape strategy
public boolean	Returns: whether empty elements are expanded getExpandEmptyElements() Returns whether empty elements are expanded.
public boolean	Returns: whether or not TrAX output escaping PIs are ignored. getIgnoreTrAXEscapingPIs() Returns whether JAXP TrAX processing instructions for disabling/enabling output escaping are ignored.
public String	Returns: the indent string in use getIndent() Returns the indent string in use.
public String	Returns: the current line separator getLineSeparator() Returns the current line separator.
public boolean	Returns: whether the XML declaration will be omitted getOmitDeclaration() Returns whether the XML declaration will be omitted.
public boolean	Returns: whether the XML declaration encoding will be omitted getOmitEncoding() Returns whether the XML declaration encoding will be omitted.
public static Format	Returns: a Format with whitespace beautification getPrettyFormat() Returns a new Format object that performs whitespace beautification with 2-space indents, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.
public static Format	Returns: a Format with no whitespace changes getRawFormat() Returns a new Format object that performs no whitespace changes, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.
public Format.TextMode	Returns: the current text output style getTextMode() Returns the current text output style.
public boolean	Returns: true if the defaulted Attributes will be output isSpecifiedAttributesOnly() Will Attributes defaulted from the DTD or XMLSchema be output
public Format	Returns: a pointer to this Format for chaining setEncoding(String the encoding format. Use XML-style names like "UTF-8" or "ISO-8859-1" or "US-ASCII" encoding) Sets the output encoding.
public Format	Returns: a pointer to this Format for chaining setEscapeStrategy(EscapeStrategy the EscapeStrategy to use strategy) Sets the `EscapeStrategy` to use for character escaping.
public Format	Returns: a pointer to this Format for chaining setExpandEmptyElements(boolean `boolean` indicating whether or not empty elements should be expanded. expandEmptyElements) This will set whether empty elements are expanded from `<tagName/>` to `<tagName></tagName>`.
public void	setIgnoreTrAXEscapingPIs(boolean `boolean` indicating whether or not TrAX output escaping PIs are ignored. ignoreTrAXEscapingPIs) This will set whether JAXP TrAX processing instructions for disabling/enabling output escaping are ignored.
public Format	Returns: a pointer to this Format for chaining setIndent(String `String` to use for indentation. indent) This will set the indent `String` to use; this is usually a `String` of empty spaces.
public Format	Returns: a pointer to this Format for chaining setLineSeparator(String `String` line separator to use. separator) This will set the newline separator (`LineSeparator`).
public Format	Returns: a pointer to this Format for chaining setLineSeparator(LineSeparator `LineSeparator` line separator to us separator) This will set the newline separator sequence.
public Format	Returns: a pointer to this Format for chaining setOmitDeclaration(boolean `boolean` indicating whether or not the XML declaration should be omitted. omitDeclaration) This will set whether the XML declaration (`<?xml version="1.0"?>`) will be omitted or not.
public Format	Returns: a pointer to this Format for chaining setOmitEncoding(boolean `boolean` indicating whether or not the XML declaration should indicate the document encoding. omitEncoding) This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?>`) includes the encoding of the document.
public void	setSpecifiedAttributesOnly(boolean true if the defaulted Attributes should be ignored, false if they should be output specifiedAttributesOnly) Set whether only those Attributes specified in the input XML should be output.
public Format	Returns: a pointer to this Format for chaining setTextMode(Format.TextMode The TextMode to set. mode) This sets the text output style.
public static final String	Returns: The value trimmed trimBoth(final String The value to trim. str) Use the XML Specification definition of whitespace to trim the input value.
public static final String	Returns: The value left-trimmed trimLeft(final String The value to trim. str) Use the XML Specification definition of whitespace to Left-trim the input value.
public static final String	Returns: The value right-trimmed trimRight(String The value to trim. str) Use the XML Specification definition of whitespace to Right-trim the input value.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

Bits7EscapeStrategy	back to summary
private static final EscapeStrategy Bits7EscapeStrategy An EscapeStrategy suitable for 7-bit charsets

Bits8EscapeStrategy	back to summary
private static final EscapeStrategy Bits8EscapeStrategy An EscapeStrategy suitable for 8-bit charsets

DefaultEscapeStrategy	back to summary
private static final EscapeStrategy DefaultEscapeStrategy An EscapeStrategy suitable for 'unknown' charsets

encoding	back to summary
pack-priv String encoding The encoding format

escapeStrategy	back to summary
pack-priv EscapeStrategy escapeStrategy entity escape logic

expandEmptyElements	back to summary
pack-priv boolean expandEmptyElements Whether or not to expand empty elements to <tagName></tagName> - default is `false`

ignoreTrAXEscapingPIs	back to summary
pack-priv boolean ignoreTrAXEscapingPIs Whether TrAX output escaping disabling/enabling PIs are ignored or processed - default is `false`

indent	back to summary
pack-priv String indent The default indent is no spaces (as original document)

lineSeparator	back to summary
pack-priv String lineSeparator New line separator

mode	back to summary
pack-priv Format.TextMode mode text handling mode

omitDeclaration	back to summary
pack-priv boolean omitDeclaration Whether or not to output the XML declaration - default is `false`

omitEncoding	back to summary
pack-priv boolean omitEncoding Whether or not to output the encoding in the XML declaration - default is `false`

specifiedAttributesOnly	back to summary
pack-priv boolean specifiedAttributesOnly Whether Attributes that are defaulted from the DTD or Schema are output.

STANDARD_ENCODING	back to summary
private static final String STANDARD_ENCODING standard encoding

STANDARD_INDENT	back to summary
private static final String STANDARD_INDENT standard value to indent by, if we are indenting

STANDARD_LINE_SEPARATOR	back to summary
private static final String STANDARD_LINE_SEPARATOR standard string with which to end a line

UTFEscapeStrategy	back to summary
private static final EscapeStrategy UTFEscapeStrategy An EscapeStrategy suitable for UTF-8 an UTF-16

Constructor Detail

Format	back to summary
private Format() Creates a new Format instance with default (raw) behavior.

Method Detail

chooseStrategy	back to summary
private static final EscapeStrategy chooseStrategy(String encoding)

clone back to summary

clone	back to summary
public Format clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Format a clone of this instance. Annotations @Override

public Format clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Format

a clone of this instance.

Annotations

@Override

compact	back to summary
public static final String compact(String str) Use the XML Specification definition of whitespace to compact the input value. The value is trimmed, and any internal XML whitespace is replaced with a single ' ' space. Parameters str:String The value to compact. Returns:String The compacted value Since JDOM2

compact

back to summary

public static final String compact(String str)

Use the XML Specification definition of whitespace to compact the input value. The value is trimmed, and any internal XML whitespace is replaced with a single ' ' space.

Parameters

str:String: The value to compact.

Returns:String

The compacted value

Since

JDOM2

escapeAttribute back to summary

escapeAttribute	back to summary
public static final String escapeAttribute(final EscapeStrategy strategy, final String value) This will take the three pre-defined entities in XML 1.0 ('<', '>', and '&' - used specifically in XML elements) as well as CR/NL, tabs, and Quote characters which require escaping inside Attribute values and converts their character representation to the appropriate entity reference suitable for XML attribute content. Further, some special characters (e.g. characters that are not valid in the current encoding) are converted to escaped representations. Parameters strategy:EscapeStrategy The EscapeStrategy to query. value:String `String` Attribute value to escape. Returns:String The value appropriately escaped. Exceptions IllegalDataException: if an entity can not be escaped

public static final String escapeAttribute(final EscapeStrategy strategy, final String value)

This will take the three pre-defined entities in XML 1.0 ('<', '>', and '&' - used specifically in XML elements) as well as CR/NL, tabs, and Quote characters which require escaping inside Attribute values and converts their character representation to the appropriate entity reference suitable for XML attribute content. Further, some special characters (e.g. characters that are not valid in the current encoding) are converted to escaped representations.

Parameters

strategy:EscapeStrategy: The EscapeStrategy to query.
value:String: String Attribute value to escape.

Returns:String

The value appropriately escaped.

Exceptions

IllegalDataException:: if an entity can not be escaped

escapeText	back to summary
public static final String escapeText(final EscapeStrategy strategy, final String eol, final String value) This will take the three pre-defined entities in XML 1.0 ('<', '>', and '&' - used specifically in XML elements) and convert their character representation to the appropriate entity reference, suitable for XML element content. Further, some special characters (e.g. characters that are not valid in the current encoding) are converted to escaped representations. If the eol parameter is not null, then any internal newlines will be replaced with the specified eol sequence. Parameters strategy:EscapeStrategy The EscapeStrategy eol:String The End-Of-Line sequence to be used (may be null). value:String The String to escape Returns:String The input value escaped. Exceptions IllegalDataException: if an entity can not be escaped Since JDOM2

escapeText

back to summary

public static final String escapeText(final EscapeStrategy strategy, final String eol, final String value)

This will take the three pre-defined entities in XML 1.0 ('<', '>', and '&' - used specifically in XML elements) and convert their character representation to the appropriate entity reference, suitable for XML element content. Further, some special characters (e.g. characters that are not valid in the current encoding) are converted to escaped representations. If the eol parameter is not null, then any internal newlines will be replaced with the specified eol sequence.

Parameters

strategy:EscapeStrategy: The EscapeStrategy
eol:String: The End-Of-Line sequence to be used (may be null).
value:String: The String to escape

Returns:String

The input value escaped.

Exceptions

IllegalDataException:: if an entity can not be escaped

Since

JDOM2

getCompactFormat	back to summary
public static Format getCompactFormat() Returns a new Format object that performs whitespace normalization, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy. Tweaks can be made to the returned Format instance without affecting other instances. Returns:Format a Format with whitespace normalization

getCompactFormat

back to summary

public static Format getCompactFormat()

Returns a new Format object that performs whitespace normalization, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy. Tweaks can be made to the returned Format instance without affecting other instances.

Returns:Format: a Format with whitespace normalization

getEncoding	back to summary
public String getEncoding() Returns the configured output encoding. Returns:String the output encoding

getEncoding

back to summary

public String getEncoding()

Returns the configured output encoding.

Returns:String: the output encoding

getEscapeStrategy	back to summary
public EscapeStrategy getEscapeStrategy() Returns the current escape strategy Returns:EscapeStrategy the current escape strategy

getEscapeStrategy

back to summary

public EscapeStrategy getEscapeStrategy()

Returns the current escape strategy

Returns:EscapeStrategy: the current escape strategy

getExpandEmptyElements	back to summary
public boolean getExpandEmptyElements() Returns whether empty elements are expanded. Returns:boolean whether empty elements are expanded

getExpandEmptyElements

back to summary

public boolean getExpandEmptyElements()

Returns whether empty elements are expanded.

Returns:boolean: whether empty elements are expanded

getIgnoreTrAXEscapingPIs	back to summary
public boolean getIgnoreTrAXEscapingPIs() Returns whether JAXP TrAX processing instructions for disabling/enabling output escaping are ignored. Returns:boolean whether or not TrAX output escaping PIs are ignored.

getIgnoreTrAXEscapingPIs

back to summary

public boolean getIgnoreTrAXEscapingPIs()

Returns whether JAXP TrAX processing instructions for disabling/enabling output escaping are ignored.

Returns:boolean: whether or not TrAX output escaping PIs are ignored.

getIndent	back to summary
public String getIndent() Returns the indent string in use. Returns:String the indent string in use

getIndent

back to summary

public String getIndent()

Returns the indent string in use.

Returns:String: the indent string in use

getLineSeparator	back to summary
public String getLineSeparator() Returns the current line separator. Returns:String the current line separator

getLineSeparator

back to summary

public String getLineSeparator()

Returns the current line separator.

Returns:String: the current line separator

getOmitDeclaration	back to summary
public boolean getOmitDeclaration() Returns whether the XML declaration will be omitted. Returns:boolean whether the XML declaration will be omitted

getOmitDeclaration

back to summary

public boolean getOmitDeclaration()

Returns whether the XML declaration will be omitted.

Returns:boolean: whether the XML declaration will be omitted

getOmitEncoding	back to summary
public boolean getOmitEncoding() Returns whether the XML declaration encoding will be omitted. Returns:boolean whether the XML declaration encoding will be omitted

getOmitEncoding

back to summary

public boolean getOmitEncoding()

Returns whether the XML declaration encoding will be omitted.

Returns:boolean: whether the XML declaration encoding will be omitted

getPrettyFormat	back to summary
public static Format getPrettyFormat() Returns a new Format object that performs whitespace beautification with 2-space indents, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy. Tweaks can be made to the returned Format instance without affecting other instances. Returns:Format a Format with whitespace beautification

getPrettyFormat

back to summary

public static Format getPrettyFormat()

Returns a new Format object that performs whitespace beautification with 2-space indents, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy. Tweaks can be made to the returned Format instance without affecting other instances.

Returns:Format: a Format with whitespace beautification

getRawFormat	back to summary
public static Format getRawFormat() Returns a new Format object that performs no whitespace changes, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy. Tweaks can be made to the returned Format instance without affecting other instances. Returns:Format a Format with no whitespace changes

getRawFormat

back to summary

public static Format getRawFormat()

Returns a new Format object that performs no whitespace changes, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy. Tweaks can be made to the returned Format instance without affecting other instances.

Returns:Format: a Format with no whitespace changes

getTextMode	back to summary
public Format.TextMode getTextMode() Returns the current text output style. Returns:Format.TextMode the current text output style

getTextMode

back to summary

public Format.TextMode getTextMode()

Returns the current text output style.

Returns:Format.TextMode: the current text output style

isSpecifiedAttributesOnly	back to summary
public boolean isSpecifiedAttributesOnly() Will Attributes defaulted from the DTD or XMLSchema be output Returns:boolean true if the defaulted Attributes will be output

isSpecifiedAttributesOnly

back to summary

public boolean isSpecifiedAttributesOnly()

Will Attributes defaulted from the DTD or XMLSchema be output

Returns:boolean: true if the defaulted Attributes will be output

setEncoding	back to summary
public Format setEncoding(String encoding) Sets the output encoding. The name should be an accepted XML encoding. Parameters encoding:String the encoding format. Use XML-style names like "UTF-8" or "ISO-8859-1" or "US-ASCII" Returns:Format a pointer to this Format for chaining

setEncoding

back to summary

public Format setEncoding(String encoding)

Sets the output encoding. The name should be an accepted XML encoding.

Parameters

encoding:String: the encoding format. Use XML-style names like "UTF-8" or "ISO-8859-1" or "US-ASCII"

Returns:Format

a pointer to this Format for chaining

setEscapeStrategy back to summary

setEscapeStrategy	back to summary
public Format setEscapeStrategy(EscapeStrategy strategy) Sets the `EscapeStrategy` to use for character escaping. Parameters strategy:EscapeStrategy the EscapeStrategy to use Returns:Format a pointer to this Format for chaining

public Format setEscapeStrategy(EscapeStrategy strategy)

Sets the EscapeStrategy to use for character escaping.

Parameters

strategy:EscapeStrategy: the EscapeStrategy to use

Returns:Format

a pointer to this Format for chaining

setExpandEmptyElements back to summary

setExpandEmptyElements	back to summary
public Format setExpandEmptyElements(boolean expandEmptyElements) This will set whether empty elements are expanded from `<tagName/>` to `<tagName></tagName>`. Parameters expandEmptyElements:boolean `boolean` indicating whether or not empty elements should be expanded. Returns:Format a pointer to this Format for chaining

public Format setExpandEmptyElements(boolean expandEmptyElements)

This will set whether empty elements are expanded from <tagName/> to <tagName></tagName>.

Parameters

expandEmptyElements:boolean: boolean indicating whether or not empty elements should be expanded.

Returns:Format

a pointer to this Format for chaining

setIgnoreTrAXEscapingPIs back to summary

setIgnoreTrAXEscapingPIs	back to summary
public void setIgnoreTrAXEscapingPIs(boolean ignoreTrAXEscapingPIs) This will set whether JAXP TrAX processing instructions for disabling/enabling output escaping are ignored. Disabling output escaping allows using XML text as element content and outputting it verbatim, i.e. as element children would be. When processed, these processing instructions are removed from the generated XML text and control whether the element text content is output verbatim or with escaping of the pre-defined entities in XML 1.0. The text to be output verbatim shall be surrounded by the `<?javax.xml.transform.disable-output-escaping ?>` and `<?javax.xml.transform.enable-output-escaping ?>` PIs. When ignored, the processing instructions are present in the generated XML text and the pre-defined entities in XML 1.0 are escaped. Default: `false`. Parameters ignoreTrAXEscapingPIs:boolean `boolean` indicating whether or not TrAX output escaping PIs are ignored. See Also `javax.xml.transform.Result#PI_ENABLE_OUTPUT_ESCAPING`, `javax.xml.transform.Result#PI_DISABLE_OUTPUT_ESCAPING`

public void setIgnoreTrAXEscapingPIs(boolean ignoreTrAXEscapingPIs)

This will set whether JAXP TrAX processing instructions for disabling/enabling output escaping are ignored. Disabling output escaping allows using XML text as element content and outputting it verbatim, i.e. as element children would be.

When processed, these processing instructions are removed from the generated XML text and control whether the element text content is output verbatim or with escaping of the pre-defined entities in XML 1.0. The text to be output verbatim shall be surrounded by the <?javax.xml.transform.disable-output-escaping ?> and <?javax.xml.transform.enable-output-escaping ?> PIs.

When ignored, the processing instructions are present in the generated XML text and the pre-defined entities in XML 1.0 are escaped.

Default: false.

Parameters

ignoreTrAXEscapingPIs:boolean: boolean indicating whether or not TrAX output escaping PIs are ignored.

setIndent back to summary

setIndent	back to summary
public Format setIndent(String indent) This will set the indent `String` to use; this is usually a `String` of empty spaces. If you pass the empty string (""), then no indentation will happen but newlines will still be generated. Passing null will result in no indentation and no newlines generated. Default: none (null) Parameters indent:String `String` to use for indentation. Returns:Format a pointer to this Format for chaining

public Format setIndent(String indent)

This will set the indent String to use; this is usually a String of empty spaces. If you pass the empty string (""), then no indentation will happen but newlines will still be generated. Passing null will result in no indentation and no newlines generated. Default: none (null)

Parameters

indent:String: String to use for indentation.

Returns:Format

a pointer to this Format for chaining

setLineSeparator back to summary

setLineSeparator	back to summary
public Format setLineSeparator(String separator) This will set the newline separator (`LineSeparator`). The default is `\r\n`. Use the `setLineSeparator(LineSeparator)` method to set standard separators in an easier way. To make it output the system default line ending string, call `setLineSeparator(System.getProperty("line.separator"))`. To output "UNIX-style" documents, call `setLineSeparator("\n")`. To output "Mac-style" documents, call `setLineSeparator("\r")`. DOS-style documents use CR-LF ("\r\n"), which is the default. Note that this only applies to newlines generated by the outputter. All XML parsers are required to 'normalize' all the combinations of line separators to just '\n'. As a result, if any JDOM component has an end-of-line-like value (e.g. '\r') in it then that value must be the result of an escaped value in the XML source document ` ` or a value explicitly set with one of the Text value setters. Values in JDOM content that were explicitly set to be '\r' will always be escaped on XML Output. The actual newline separator itself though can be set with this method. Any internal newlines in Text output will be represented by this end-of-line sequence. For example, the following code: Text txt = new Text("\r\n"); XMLOutputter xout = new XMLOutputter(); String result = xout.outputString(txt); will produce the literal String sequence " \r\n" because the original \r is escaped to be ` ` and the original \n is replaced with the JDOM default Line Separator "\r\n". If the format's "indent" property is null (as is the default for the Raw and Compact formats), then this value only effects the newlines written after the declaration and doctype, as well as any newlines embedded within existing text content. Setting the indent to be null will disable end-of-line processing for any formatting, but will not affect substitution of embedded \n. Setting this value to null or the empty string will disable all end-of-line modifications. Parameters separator:String `String` line separator to use. Returns:Format a pointer to this Format for chaining See Also `setTextMode`, `setLineSeparator(LineSeparator)`

public Format setLineSeparator(String separator)

This will set the newline separator (LineSeparator). The default is \r\n.

Use the setLineSeparator(LineSeparator) method to set standard separators in an easier way.

To make it output the system default line ending string, call setLineSeparator(System.getProperty("line.separator")).

To output "UNIX-style" documents, call setLineSeparator("\n"). To output "Mac-style" documents, call setLineSeparator("\r"). DOS-style documents use CR-LF ("\r\n"), which is the default.

Note that this only applies to newlines generated by the outputter. All XML parsers are required to 'normalize' all the combinations of line separators to just '\n'. As a result, if any JDOM component has an end-of-line-like value (e.g. '\r') in it then that value must be the result of an escaped value in the XML source document  or a value explicitly set with one of the Text value setters. Values in JDOM content that were explicitly set to be '\r' will always be escaped on XML Output.

The actual newline separator itself though can be set with this method. Any internal newlines in Text output will be represented by this end-of-line sequence. For example, the following code:

  Text txt = new Text("\r\n");
  XMLOutputter xout = new XMLOutputter();
  String result = xout.outputString(txt);

will produce the literal String sequence "\r\n" because the original \r is escaped to be  and the original \n is replaced with the JDOM default Line Separator "\r\n".

If the format's "indent" property is null (as is the default for the Raw and Compact formats), then this value only effects the newlines written after the declaration and doctype, as well as any newlines embedded within existing text content.

Setting the indent to be null will disable end-of-line processing for any formatting, but will not affect substitution of embedded \n. Setting this value to null or the empty string will disable all end-of-line modifications.

Parameters

separator:String: String line separator to use.

Returns:Format

a pointer to this Format for chaining

setLineSeparator back to summary

setLineSeparator	back to summary
public Format setLineSeparator(LineSeparator separator) This will set the newline separator sequence. This method differs from `setLineSeparator(String)` slightly in that, to disable end-of-line processing you should call: Format.setLinewSeparator(LineSeparator.NONE); Parameters separator:LineSeparator `LineSeparator` line separator to us Returns:Format a pointer to this Format for chaining Since JDOM2 See Also `for comprehensive notes.`

public Format setLineSeparator(LineSeparator separator)

This will set the newline separator sequence.

This method differs from setLineSeparator(String) slightly in that, to disable end-of-line processing you should call:

Format.setLinewSeparator(LineSeparator.NONE);

Parameters

separator:LineSeparator: LineSeparator line separator to us

Returns:Format

a pointer to this Format for chaining

Since

JDOM2

See Also

for comprehensive notes.

setOmitDeclaration back to summary

setOmitDeclaration	back to summary
public Format setOmitDeclaration(boolean omitDeclaration) This will set whether the XML declaration (`<?xml version="1.0"?>`) will be omitted or not. It is common to omit this in uses such as SOAP and XML-RPC calls. Parameters omitDeclaration:boolean `boolean` indicating whether or not the XML declaration should be omitted. Returns:Format a pointer to this Format for chaining

public Format setOmitDeclaration(boolean omitDeclaration)

This will set whether the XML declaration (<?xml version="1.0"?>) will be omitted or not. It is common to omit this in uses such as SOAP and XML-RPC calls.

Parameters

omitDeclaration:boolean: boolean indicating whether or not the XML declaration should be omitted.

Returns:Format

a pointer to this Format for chaining

setOmitEncoding back to summary

setOmitEncoding	back to summary
public Format setOmitEncoding(boolean omitEncoding) This will set whether the XML declaration (`<?xml version="1.0" encoding="UTF-8"?>`) includes the encoding of the document. It is common to omit this in uses such as WML and other wireless device protocols. Parameters omitEncoding:boolean `boolean` indicating whether or not the XML declaration should indicate the document encoding. Returns:Format a pointer to this Format for chaining

public Format setOmitEncoding(boolean omitEncoding)

This will set whether the XML declaration (<?xml version="1.0" encoding="UTF-8"?>) includes the encoding of the document. It is common to omit this in uses such as WML and other wireless device protocols.

Parameters

omitEncoding:boolean: boolean indicating whether or not the XML declaration should indicate the document encoding.

Returns:Format

a pointer to this Format for chaining

setSpecifiedAttributesOnly	back to summary
public void setSpecifiedAttributesOnly(boolean specifiedAttributesOnly) Set whether only those Attributes specified in the input XML should be output. Other Attributes (those defaulted or 'fixed' in the DTD or XMLSchema) should be ignored. Parameters specifiedAttributesOnly:boolean true if the defaulted Attributes should be ignored, false if they should be output

setSpecifiedAttributesOnly

back to summary

public void setSpecifiedAttributesOnly(boolean specifiedAttributesOnly)

Set whether only those Attributes specified in the input XML should be output. Other Attributes (those defaulted or 'fixed' in the DTD or XMLSchema) should be ignored.

Parameters

specifiedAttributesOnly:boolean: true if the defaulted Attributes should be ignored, false if they should be output

setTextMode back to summary

public Format setTextMode(Format.TextMode mode)

This sets the text output style. Options are available as static TextMode instances. The default is TextMode#PRESERVE.

Parameters

mode:Format.TextMode: The TextMode to set.

Returns:Format

a pointer to this Format for chaining

trimBoth

back to summary

public static final String trimBoth(final String str)

Use the XML Specification definition of whitespace to trim the input value.

Parameters

str:String: The value to trim.

Returns:String

The value trimmed

Since

JDOM2

trimLeft

back to summary

public static final String trimLeft(final String str)

Use the XML Specification definition of whitespace to Left-trim the input value.

Parameters

str:String: The value to trim.

Returns:String

The value left-trimmed

Since

JDOM2

trimRight

back to summary

public static final String trimRight(String str)

Use the XML Specification definition of whitespace to Right-trim the input value.

Parameters

str:String: The value to trim.

Returns:String

The value right-trimmed

Since

JDOM2

org.jdom2.output back to summary

private final Class Format.DefaultCharsetEscapeStrategy

Class Inheritance

extends Object
implements EscapeStrategy

java.lang.Object
org.jdom2.output.Format.DefaultCharsetEscapeStrategy

All Implemented Interfaces

org.jdom2.output.EscapeStrategy

Handles Charsets.

Field Summary

Modifier and Type	Field and Description
private final CharsetEncoder	encoder

Constructor Summary

Access	Constructor and Description
public	DefaultCharsetEscapeStrategy(CharsetEncoder cse)

Method Summary

Modifier and Type	Method and Description
public boolean	shouldEscape(final char The char to test to determine whether it should be escaped. ch) Implements org.jdom2.output.EscapeStrategy.shouldEscape. Test whether the supplied character should be formatted literally or as a character entity.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

encoder	back to summary
private final CharsetEncoder encoder

Constructor Detail

DefaultCharsetEscapeStrategy	back to summary
public DefaultCharsetEscapeStrategy(CharsetEncoder cse)

Method Detail

shouldEscape

back to summary

public boolean shouldEscape(final char ch)

Implements org.jdom2.output.EscapeStrategy.shouldEscape.

Doc from org.jdom2.output.EscapeStrategy.shouldEscape.

Test whether the supplied character should be formatted literally or as a character entity.

Parameters

ch:char: The char to test to determine whether it should be escaped.

Returns:boolean

true if ch should be escaped.

Annotations

@Override

org.jdom2.output back to summary

private final Class Format.EscapeStrategy7Bits

Class Inheritance

extends Object
implements EscapeStrategy

java.lang.Object
org.jdom2.output.Format.EscapeStrategy7Bits

All Implemented Interfaces

org.jdom2.output.EscapeStrategy

An EscapeStrategy suitable for 7-bit charsets. We want the class to have its own name.

Constructor Summary

Access	Constructor and Description
private	EscapeStrategy7Bits()

Method Summary

Modifier and Type	Method and Description
public boolean	shouldEscape(final char The char to test to determine whether it should be escaped. ch) Implements org.jdom2.output.EscapeStrategy.shouldEscape. Test whether the supplied character should be formatted literally or as a character entity.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

EscapeStrategy7Bits	back to summary
private EscapeStrategy7Bits()

Method Detail

shouldEscape

back to summary

public boolean shouldEscape(final char ch)

Implements org.jdom2.output.EscapeStrategy.shouldEscape.

Doc from org.jdom2.output.EscapeStrategy.shouldEscape.

Test whether the supplied character should be formatted literally or as a character entity.

Parameters

ch:char: The char to test to determine whether it should be escaped.

Returns:boolean

true if ch should be escaped.

Annotations

@Override

org.jdom2.output back to summary

private final Class Format.EscapeStrategy8Bits

Class Inheritance

extends Object
implements EscapeStrategy

java.lang.Object
org.jdom2.output.Format.EscapeStrategy8Bits

All Implemented Interfaces

org.jdom2.output.EscapeStrategy

An EscapeStrategy suitable for 8-bit charsets. We want the class to have its own name.

Constructor Summary

Access	Constructor and Description
private	EscapeStrategy8Bits()

Method Summary

Modifier and Type	Method and Description
public boolean	shouldEscape(final char The char to test to determine whether it should be escaped. ch) Implements org.jdom2.output.EscapeStrategy.shouldEscape. Test whether the supplied character should be formatted literally or as a character entity.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

EscapeStrategy8Bits	back to summary
private EscapeStrategy8Bits()

Method Detail

shouldEscape

back to summary

public boolean shouldEscape(final char ch)

Implements org.jdom2.output.EscapeStrategy.shouldEscape.

Doc from org.jdom2.output.EscapeStrategy.shouldEscape.

Test whether the supplied character should be formatted literally or as a character entity.

Parameters

ch:char: The char to test to determine whether it should be escaped.

Returns:boolean

true if ch should be escaped.

Annotations

@Override

org.jdom2.output back to summary

private final Class Format.EscapeStrategyUTF

Class Inheritance

extends Object
implements EscapeStrategy

java.lang.Object
org.jdom2.output.Format.EscapeStrategyUTF

All Implemented Interfaces

org.jdom2.output.EscapeStrategy

An EscapeStrategy suitable for UTF-8 an UTF-16. We want the class to have its own name.

Constructor Summary

Access	Constructor and Description
private	EscapeStrategyUTF()

Method Summary

Modifier and Type	Method and Description
public final boolean	shouldEscape(char The char to test to determine whether it should be escaped. ch) Implements org.jdom2.output.EscapeStrategy.shouldEscape. Test whether the supplied character should be formatted literally or as a character entity.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

EscapeStrategyUTF	back to summary
private EscapeStrategyUTF()

Method Detail

shouldEscape

back to summary

public final boolean shouldEscape(char ch)

Implements org.jdom2.output.EscapeStrategy.shouldEscape.

Doc from org.jdom2.output.EscapeStrategy.shouldEscape.

Test whether the supplied character should be formatted literally or as a character entity.

Parameters

ch:char: The char to test to determine whether it should be escaped.

Returns:boolean

true if ch should be escaped.

Annotations

@Override

org.jdom2.output back to summary

public final Enum Format.TextMode

Class Inheritance

extends Enum<Format.TextMode>

java.lang.Object
java.lang.Enum
org.jdom2.output.Format.TextMode

Class to signify how text should be handled on output. The following table provides details.

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.

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.

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

Field Summary

Modifier and Type	Field and Description
public static final Format.TextMode	NORMALIZE Mode for text normalization (left and right trim plus internal whitespace is normalized to a single space.
public static final Format.TextMode	PRESERVE Mode for literal text preservation.
public static final Format.TextMode	TRIM Mode for text trimming (left and right trim).
public static final Format.TextMode	TRIM_FULL_WHITE Mode for text trimming of content consisting of nothing but whitespace but otherwise not changing output.

Constructor Summary

Access	Constructor and Description
private	TextMode()

Method Summary

Modifier and Type	Method and Description
public static Format.TextMode	valueOf(String name)
public static Format.TextMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NORMALIZE back to summary

public static final Format.TextMode NORMALIZE

Mode for text normalization (left and right trim plus internal whitespace is normalized to a single space.

See Also: org.jdom2.Element#getTextNormalize

PRESERVE	back to summary
public static final Format.TextMode PRESERVE Mode for literal text preservation.

TRIM	back to summary
public static final Format.TextMode TRIM Mode for text trimming (left and right trim).

TRIM_FULL_WHITE	back to summary
public static final Format.TextMode TRIM_FULL_WHITE Mode for text trimming of content consisting of nothing but whitespace but otherwise not changing output.

Constructor Detail

TextMode	back to summary
private TextMode()

Method Detail

valueOf	back to summary
public static Format.TextMode valueOf(String name)

values	back to summary
public static Format.TextMode[] values()

public Class Format

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Format.DefaultCharsetEscapeStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Format.EscapeStrategy7Bits

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class Format.EscapeStrategy8Bits

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class Format.EscapeStrategyUTF

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum Format.TextMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail