org.jdom.output
public class Format extends Object implements Cloneable
Several modes are available to effect the way textual content is printed. See the documentation for {@link TextMode} for details.
Version: $Revision: 1.10 $, $Date: 2004/09/07 06:37:20 $
Nested Class Summary | |
---|---|
static class | Format.TextMode
Class to signify how text should be handled on output. |
Method Summary | |
---|---|
protected Object | clone() |
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.
|
String | getEncoding()
Returns the configured output encoding.
|
EscapeStrategy | getEscapeStrategy()
Returns the current escape strategy
|
boolean | getExpandEmptyElements()
Returns whether empty elements are expanded.
|
boolean | getIgnoreTrAXEscapingPIs()
Returns whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored.
|
String | getIndent()
Returns the indent string in use.
|
String | getLineSeparator()
Returns the current line separator.
|
boolean | getOmitDeclaration()
Returns whether the XML declaration will be omitted.
|
boolean | getOmitEncoding()
Returns whether the XML declaration encoding will be omitted.
|
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.
|
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.
|
Format.TextMode | getTextMode()
Returns the current text output style.
|
Format | setEncoding(String encoding)
Sets the output encoding. |
Format | setEscapeStrategy(EscapeStrategy strategy)
Sets the {@link EscapeStrategy} to use for character escaping.
|
Format | setExpandEmptyElements(boolean expandEmptyElements)
This will set whether empty elements are expanded from
<tagName/> to
<tagName></tagName> .
|
void | setIgnoreTrAXEscapingPIs(boolean ignoreTrAXEscapingPIs)
This will set whether JAXP TrAX processing instructions for
disabling/enabling output escaping are ignored. |
Format | setIndent(String indent)
This will set the indent String to use; this
is usually a String of empty spaces. |
Format | setLineSeparator(String separator)
This will set the newline separator ( lineSeparator ).
|
Format | setOmitDeclaration(boolean omitDeclaration)
This will set whether the XML declaration
( <?xml version="1.0"?gt; )
will be omitted or not. |
Format | setOmitEncoding(boolean omitEncoding)
This will set whether the XML declaration
( <?xml version="1.0"
encoding="UTF-8"?> )
includes the encoding of the document. |
Format | setTextMode(Format.TextMode mode)
This sets the text output style. |
Returns: a Format with whitespace normalization
Returns: the output encoding
Returns: the current escape strategy
Returns: whether empty elements are expanded
Returns: whether or not TrAX ouput escaping PIs are ignored.
Returns: the indent string in use
Returns: the current line separator
Returns: whether the XML declaration will be omitted
Returns: whether the XML declaration encoding will be omitted
Returns: a Format with whitespace beautification
Returns: a Format with no whitespace changes
Returns: the current text output style
Parameters: encoding the encoding format. Use XML-style names like "UTF-8" or "ISO-8859-1" or "US-ASCII"
Returns: a pointer to this Format for chaining
Parameters: strategy the EscapeStrategy to use
Returns: a pointer to this Format for chaining
<tagName/>
to
<tagName></tagName>
.
Parameters: expandEmptyElements boolean
indicating whether or not
empty elements should be expanded.
Returns: a pointer to this Format for chaining
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
indicating
whether or not TrAX ouput escaping PIs are ignored.
See Also: javax.xml.transform.Result#PI_ENABLE_OUTPUT_ESCAPING javax.xml.transform.Result#PI_DISABLE_OUTPUT_ESCAPING
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.
Returns: a pointer to this Format for chaining
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.
Parameters: separator String
line separator to use.
Returns: a pointer to this Format for chaining
See Also: Format
<?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 not
the XML declaration should be omitted.
Returns: a pointer to this Format for chaining
<?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 not
the XML declaration should indicate the document encoding.
Returns: a pointer to this Format for chaining
Returns: a pointer to this Format for chaining