| java.lang.Object
 org.jdom.output.Format
| Format | | public class Format implements Cloneable(Code) | | Class to encapsulate XMLOutputter format options.
Typical users can use the standard format configurations obtained by
Format.getRawFormat (no whitespace changes),
Format.getPrettyFormat (whitespace beautification), and
Format.getCompactFormat (whitespace normalization).
Several modes are available to effect the way textual content is printed.
See the documentation for
TextMode for details.
version:
$Revision: 1.1 $, $Date: 2005/04/27 09:32:42 $
author:
Jason Hunter |
| Inner Class :public static class TextMode | |
| Method Summary | |
| protected Object | clone()
| | 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. | | public String | getEncoding()
Returns the configured output encoding. | | public EscapeStrategy | getEscapeStrategy()
| | public boolean | getExpandEmptyElements()
Returns whether empty elements are expanded. | | public boolean | getIgnoreTrAXEscapingPIs()
Returns whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored. | | public String | getIndent()
Returns the indent string in use. | | public String | getLineSeparator()
Returns the current line separator. | | public boolean | getOmitDeclaration()
Returns whether the XML declaration will be omitted. | | public boolean | getOmitEncoding()
Returns whether the XML declaration encoding will be omitted. | | 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. | | 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. | | public Format.TextMode | getTextMode()
Returns the current text output style. | | public Format | setEncoding(String encoding)
Sets the output encoding. | | public Format | setEscapeStrategy(EscapeStrategy strategy)
Sets the
EscapeStrategy to use for character escaping. | | public Format | setExpandEmptyElements(boolean expandEmptyElements)
This will set whether empty elements are expanded from
<tagName/> to
<tagName></tagName>.
Parameters:
expandEmptyElements - boolean indicating whether or notempty elements should be expanded. | | public void | setIgnoreTrAXEscapingPIs(boolean ignoreTrAXEscapingPIs)
This will set whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored. | | public Format | setIndent(String indent)
This will set the indent String to use; this
is usually a String of empty spaces. | | public Format | setLineSeparator(String separator)
This will set the newline separator (lineSeparator).
The default is \r\n. | | public Format | setOmitDeclaration(boolean omitDeclaration)
This will set whether the XML declaration
(<?xml version="1.0"?gt;)
will be omitted or not. | | 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. | | public Format | setTextMode(Format.TextMode mode)
This sets the text output style. |
| expandEmptyElements | | boolean expandEmptyElements(Code) | | Whether or not to expand empty elements to
<tagName></tagName> - default is false
|
| ignoreTrAXEscapingPIs | | boolean ignoreTrAXEscapingPIs(Code) | | Whether TrAX output escaping disabling/enabling PIs are ignored
or processed - default is false
|
| indent | | String indent(Code) | | The default indent is no spaces (as original document)
|
| mode | | TextMode mode(Code) | | text handling mode
|
| omitDeclaration | | boolean omitDeclaration(Code) | | Whether or not to output the XML declaration
- default is false
|
| omitEncoding | | boolean omitEncoding(Code) | | Whether or not to output the encoding in the XML declaration
- default is false
|
| getCompactFormat | | public static Format getCompactFormat()(Code) | | 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.
a Format with whitespace normalization |
| getEncoding | | public String getEncoding()(Code) | | Returns the configured output encoding.
the output encoding |
| getEscapeStrategy | | public EscapeStrategy getEscapeStrategy()(Code) | | Returns the current escape strategy
the current escape strategy |
| getExpandEmptyElements | | public boolean getExpandEmptyElements()(Code) | | Returns whether empty elements are expanded.
whether empty elements are expanded |
| getIgnoreTrAXEscapingPIs | | public boolean getIgnoreTrAXEscapingPIs()(Code) | | Returns whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored.
whether or not TrAX ouput escaping PIs are ignored. |
| getIndent | | public String getIndent()(Code) | | Returns the indent string in use.
the indent string in use |
| getLineSeparator | | public String getLineSeparator()(Code) | | Returns the current line separator.
the current line separator |
| getOmitDeclaration | | public boolean getOmitDeclaration()(Code) | | Returns whether the XML declaration will be omitted.
whether the XML declaration will be omitted |
| getOmitEncoding | | public boolean getOmitEncoding()(Code) | | Returns whether the XML declaration encoding will be omitted.
whether the XML declaration encoding will be omitted |
| getPrettyFormat | | public static Format getPrettyFormat()(Code) | | 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.
a Format with whitespace beautification |
| getRawFormat | | public static Format getRawFormat()(Code) | | 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.
a Format with no whitespace changes |
| getTextMode | | public Format.TextMode getTextMode()(Code) | | Returns the current text output style.
the current text output style |
| setEncoding | | public Format setEncoding(String encoding)(Code) | | Sets the output encoding. The name should be an accepted XML
encoding.
Parameters:
encoding - the encoding format. Use XML-style names like"UTF-8" or "ISO-8859-1" or "US-ASCII" a pointer to this Format for chaining |
| setEscapeStrategy | | public Format setEscapeStrategy(EscapeStrategy strategy)(Code) | | Sets the
EscapeStrategy to use for character escaping.
Parameters:
strategy - the EscapeStrategy to use a pointer to this Format for chaining |
| setExpandEmptyElements | | public Format setExpandEmptyElements(boolean expandEmptyElements)(Code) | | This will set whether empty elements are expanded from
<tagName/> to
<tagName></tagName>.
Parameters:
expandEmptyElements - boolean indicating whether or notempty elements should be expanded. a pointer to this Format for chaining |
| setIgnoreTrAXEscapingPIs | | public void setIgnoreTrAXEscapingPIs(boolean ignoreTrAXEscapingPIs)(Code) | | 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
outputing 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 indicatingwhether or not TrAX ouput escaping PIs are ignored.
See Also: javax.xml.transform.Result.PI_ENABLE_OUTPUT_ESCAPING
See Also: javax.xml.transform.Result.PI_DISABLE_OUTPUT_ESCAPING |
| setIndent | | public Format setIndent(String indent)(Code) | | This will set the indent String to use; this
is usually a String of empty spaces. If you pass
null, or the empty string (""), then no indentation will
happen. Default: none (null)
Parameters:
indent - String to use for indentation. a pointer to this Format for chaining |
| setLineSeparator | | public Format setLineSeparator(String separator)(Code) | | This will set the newline separator (lineSeparator).
The default is \r\n. Note that if the "newlines"
property is false, this value is irrelevant. 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. If you parse an XML document that contains newlines
embedded inside a text node, and you do not set TextMode.NORMALIZE,
then the newlines will be output
verbatim, as "\n" which is how parsers normalize them.
See Also: Format.setTextMode
Parameters:
separator - String line separator to use. a pointer to this Format for chaining |
| setOmitDeclaration | | public Format setOmitDeclaration(boolean omitDeclaration)(Code) | | This will set whether the XML declaration
(<?xml version="1.0"?gt;)
will be omitted or not. It is common to omit this in uses such
as SOAP and XML-RPC calls.
Parameters:
omitDeclaration - boolean indicating whether or notthe XML declaration should be omitted. a pointer to this Format for chaining |
| setOmitEncoding | | public Format setOmitEncoding(boolean omitEncoding)(Code) | | 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 indicating whether or notthe XML declaration should indicate the document encoding. a pointer to this Format for chaining |
| setTextMode | | public Format setTextMode(Format.TextMode mode)(Code) | | This sets the text output style. Options are available as static
TextMode instances. The default is
TextMode.PRESERVE .
a pointer to this Format for chaining |
|
|