| java.lang.Object
 org.apache.xml.serialize.OutputFormat
| OutputFormat | | public class OutputFormat (Code) | | Specifies an output format to control the serializer. Based on the
XSLT specification for output format, plus additional parameters.
Used to select the suitable serializer and determine how the
document should be formatted on output.
The two interesting constructors are:
-
OutputFormat.OutputFormat(String,String,boolean) creates a format
for the specified method (XML, HTML, Text, etc), encoding and indentation
-
OutputFormat.OutputFormat(Document,String,boolean) creates a format
compatible with the document type (XML, HTML, Text, etc), encoding and
indentation
version:
$Revision: 1.11.2.1 $ $Date: 2001/11/07 19:00:34 $
author:
Assaf Arkin
author:
Keith Visco
See Also: Serializer
See Also: Method
See Also: LineSeparator |
| Inner Class :public static class DTD | |
| Inner Class :public static class Defaults | |
| Constructor Summary | |
| public | OutputFormat()
Constructs a new output format with the default values. | | public | OutputFormat(String method, String encoding, boolean indenting)
Constructs a new output format with the default values for
the specified method and encoding. | | public | OutputFormat(Document doc)
Constructs a new output format with the proper method,
document type identifiers and media type for the specified
document. | | public | OutputFormat(Document doc, String encoding, boolean indenting)
Constructs a new output format with the proper method,
document type identifiers and media type for the specified
document, and with the specified encoding. |
| Method Summary | |
| public String[] | getCDataElements()
Returns a list of all the elements whose text node children
should be output as CDATA, or null if no such elements were
specified. | | public String | getDoctypePublic()
Returns the specified document type public identifier,
or null. | | public String | getDoctypeSystem()
Returns the specified document type system identifier,
or null. | | public String | getEncoding()
Returns the specified encoding. | | public EncodingInfo | getEncodingInfo()
Returns an EncodingInfo instance for the encoding. | | public int | getIndent()
Returns the indentation specified. | | public boolean | getIndenting()
Returns true if indentation was specified. | | public char | getLastPrintable()
Returns the last printable character based on the selected
encoding. | | public String | getLineSeparator()
Returns a specific line separator to use. | | public int | getLineWidth()
Return the selected line width for breaking up long lines. | | public String | getMediaType()
Returns the specified media type, or null. | | public String | getMethod()
Returns the method specified for this output format. | | public String[] | getNonEscapingElements()
Returns a list of all the elements whose text node children
should be output unescaped (no character references), or null
if no such elements were specified. | | public boolean | getOmitComments()
Returns true if comments should be ommited. | | public boolean | getOmitDocumentType()
Returns true if the DOCTYPE declaration should
be ommited. | | public boolean | getOmitXMLDeclaration()
Returns true if the XML document declaration should
be ommited. | | public boolean | getPreserveEmptyAttributes()
Returns the preserveEmptyAttribute flag. | | public boolean | getPreserveSpace()
Returns true if the default behavior for this format is to
preserve spaces. | | public boolean | getStandalone()
Returns true if the document type is standalone. | | public String | getVersion()
Returns the version for this output method. | | public boolean | isCDataElement(String tagName)
Returns true if the text node children of the given elements
should be output as CDATA. | | public boolean | isNonEscapingElement(String tagName)
Returns true if the text node children of the given elements
should be output unescaped. | | public void | setCDataElements(String[] cdataElements)
Sets the list of elements for which text node children
should be output as CDATA. | | public void | setDoctype(String publicId, String systemId)
Sets the document type public and system identifiers.
Required only if the DOM Document or SAX events do not
specify the document type, and one must be present in
the serialized document. | | public void | setEncoding(String encoding)
Sets the encoding for this output method. | | public void | setEncoding(EncodingInfo encInfo)
Sets the encoding for this output method with an EncodingInfo
instance. | | public void | setIndent(int indent)
Sets the indentation. | | public void | setIndenting(boolean on)
Sets the indentation on and off. | | public void | setLineSeparator(String lineSeparator)
Sets the line separator. | | public void | setLineWidth(int lineWidth)
Sets the line width. | | public void | setMediaType(String mediaType)
Sets the media type. | | public void | setMethod(String method)
Sets the method for this output format. | | public void | setNonEscapingElements(String[] nonEscapingElements)
Sets the list of elements for which text node children
should be output unescaped (no character references). | | public void | setOmitComments(boolean omit)
Sets comment omitting on and off. | | public void | setOmitDocumentType(boolean omit)
Sets DOCTYPE declaration omitting on and off. | | public void | setOmitXMLDeclaration(boolean omit)
Sets XML declaration omitting on and off. | | public void | setPreserveEmptyAttributes(boolean preserve)
Sets the preserveEmptyAttribute flag. | | public void | setPreserveSpace(boolean preserve)
Sets space preserving as the default behavior. | | public void | setStandalone(boolean standalone)
Sets document DTD standalone. | | public void | setVersion(String version)
Sets the version for this output method. | | public static String | whichDoctypePublic(Document doc)
Returns the document type public identifier
specified for this document, or null. | | public static String | whichDoctypeSystem(Document doc)
Returns the document type system identifier
specified for this document, or null. | | public static String | whichMediaType(String method)
Returns the suitable media format for a document
output with the specified method. | | public static String | whichMethod(Document doc)
Determine the output method for the specified document.
If the document is an instance of
org.w3c.dom.html.HTMLDocument then the method is said to be html. |
| OutputFormat | | public OutputFormat()(Code) | | Constructs a new output format with the default values.
|
| OutputFormat | | public OutputFormat(String method, String encoding, boolean indenting)(Code) | | Constructs a new output format with the default values for
the specified method and encoding. If indent
is true, the document will be pretty printed with the default
indentation level and default line wrapping.
Parameters:
method - The specified output method
Parameters:
encoding - The specified encoding
Parameters:
indenting - True for pretty printing
See Also: OutputFormat.setEncoding
See Also: OutputFormat.setIndenting
See Also: OutputFormat.setMethod |
| OutputFormat | | public OutputFormat(Document doc)(Code) | | Constructs a new output format with the proper method,
document type identifiers and media type for the specified
document.
Parameters:
doc - The document to output
See Also: OutputFormat.whichMethod |
| OutputFormat | | public OutputFormat(Document doc, String encoding, boolean indenting)(Code) | | Constructs a new output format with the proper method,
document type identifiers and media type for the specified
document, and with the specified encoding. If indent
is true, the document will be pretty printed with the default
indentation level and default line wrapping.
Parameters:
doc - The document to output
Parameters:
encoding - The specified encoding
Parameters:
indenting - True for pretty printing
See Also: OutputFormat.setEncoding
See Also: OutputFormat.setIndenting
See Also: OutputFormat.whichMethod |
| getCDataElements | | public String[] getCDataElements()(Code) | | Returns a list of all the elements whose text node children
should be output as CDATA, or null if no such elements were
specified.
|
| getDoctypePublic | | public String getDoctypePublic()(Code) | | Returns the specified document type public identifier,
or null.
|
| getDoctypeSystem | | public String getDoctypeSystem()(Code) | | Returns the specified document type system identifier,
or null.
|
| getEncoding | | public String getEncoding()(Code) | | Returns the specified encoding. If no encoding was
specified, the default is always "UTF-8".
The encoding |
| getEncodingInfo | | public EncodingInfo getEncodingInfo()(Code) | | Returns an EncodingInfo instance for the encoding.
See Also: setEncoding |
| getIndent | | public int getIndent()(Code) | | Returns the indentation specified. If no indentation
was specified, zero is returned and the document
should not be indented.
The indentation or zero
See Also: OutputFormat.setIndenting |
| getIndenting | | public boolean getIndenting()(Code) | | Returns true if indentation was specified.
|
| getLastPrintable | | public char getLastPrintable()(Code) | | Returns the last printable character based on the selected
encoding. Control characters and non-printable characters
are always printed as character references.
|
| getLineSeparator | | public String getLineSeparator()(Code) | | Returns a specific line separator to use. The default is the
Web line separator (\n). A string is returned to
support double codes (CR + LF).
The specified line separator |
| getLineWidth | | public int getLineWidth()(Code) | | Return the selected line width for breaking up long lines.
When indenting, and only when indenting, long lines will be
broken at space boundaries based on this line width.
No line wrapping occurs if this value is zero.
|
| getMediaType | | public String getMediaType()(Code) | | Returns the specified media type, or null.
To determine the media type based on the
document type, use
OutputFormat.whichMediaType .
The specified media type, or null |
| getMethod | | public String getMethod()(Code) | | Returns the method specified for this output format.
Typically the method will be xml, html
or text, but it might be other values.
If no method was specified, null will be returned
and the most suitable method will be determined for
the document by calling
OutputFormat.whichMethod .
The specified output method, or null |
| getNonEscapingElements | | public String[] getNonEscapingElements()(Code) | | Returns a list of all the elements whose text node children
should be output unescaped (no character references), or null
if no such elements were specified.
|
| getOmitComments | | public boolean getOmitComments()(Code) | | Returns true if comments should be ommited.
The default is false.
|
| getOmitDocumentType | | public boolean getOmitDocumentType()(Code) | | Returns true if the DOCTYPE declaration should
be ommited. The default is false.
|
| getOmitXMLDeclaration | | public boolean getOmitXMLDeclaration()(Code) | | Returns true if the XML document declaration should
be ommited. The default is false.
|
| getPreserveEmptyAttributes | | public boolean getPreserveEmptyAttributes()(Code) | | Returns the preserveEmptyAttribute flag. If flag is false, then'
attributes with empty string values are output as the attribute
name only (in HTML mode).
preserve the preserve flag |
| getPreserveSpace | | public boolean getPreserveSpace()(Code) | | Returns true if the default behavior for this format is to
preserve spaces. All elements that do not specify otherwise
or specify the default behavior will be formatted based on
this rule. All elements that specify space preserving will
always preserve space.
|
| getStandalone | | public boolean getStandalone()(Code) | | Returns true if the document type is standalone.
The default is false.
|
| getVersion | | public String getVersion()(Code) | | Returns the version for this output method.
If no version was specified, will return null
and the default version number will be used.
If the serializerr does not support that particular
version, it should default to a supported version.
The specified method version, or null |
| isCDataElement | | public boolean isCDataElement(String tagName)(Code) | | Returns true if the text node children of the given elements
should be output as CDATA.
Parameters:
tagName - The element's tag name True if should serialize as CDATA |
| isNonEscapingElement | | public boolean isNonEscapingElement(String tagName)(Code) | | Returns true if the text node children of the given elements
should be output unescaped.
Parameters:
tagName - The element's tag name True if should serialize unescaped |
| setCDataElements | | public void setCDataElements(String[] cdataElements)(Code) | | Sets the list of elements for which text node children
should be output as CDATA.
Parameters:
cdataElements - List of CDATA element tag names |
| setDoctype | | public void setDoctype(String publicId, String systemId)(Code) | | Sets the document type public and system identifiers.
Required only if the DOM Document or SAX events do not
specify the document type, and one must be present in
the serialized document. Any document type specified
by the DOM Document or SAX events will override these
values.
Parameters:
publicId - The public identifier, or null
Parameters:
systemId - The system identifier, or null |
| setEncoding | | public void setEncoding(String encoding)(Code) | | Sets the encoding for this output method. If no
encoding was specified, the default is always "UTF-8".
Make sure the encoding is compatible with the one
used by the
java.io.Writer .
See Also: OutputFormat.getEncoding
Parameters:
encoding - The encoding, or null |
| setEncoding | | public void setEncoding(EncodingInfo encInfo)(Code) | | Sets the encoding for this output method with an EncodingInfo
instance.
|
| setIndent | | public void setIndent(int indent)(Code) | | Sets the indentation. The document will not be
indented if the indentation is set to zero.
Calling
OutputFormat.setIndenting will reset this
value to zero (off) or the default (on).
Parameters:
indent - The indentation, or zero |
| setLineSeparator | | public void setLineSeparator(String lineSeparator)(Code) | | Sets the line separator. The default is the Web line separator
(\n). The machine's line separator can be obtained
from the system property line.separator, but is only
useful if the document is edited on machines of the same type.
For general documents, use the Web line separator.
Parameters:
lineSeparator - The specified line separator |
| setMethod | | public void setMethod(String method)(Code) | | Sets the method for this output format.
See Also: OutputFormat.getMethod
Parameters:
method - The output method, or null |
| setNonEscapingElements | | public void setNonEscapingElements(String[] nonEscapingElements)(Code) | | Sets the list of elements for which text node children
should be output unescaped (no character references).
Parameters:
nonEscapingElements - List of unescaped element tag names |
| setOmitComments | | public void setOmitComments(boolean omit)(Code) | | Sets comment omitting on and off.
Parameters:
omit - True if comments should be ommited |
| setOmitDocumentType | | public void setOmitDocumentType(boolean omit)(Code) | | Sets DOCTYPE declaration omitting on and off.
Parameters:
omit - True if DOCTYPE declaration should be ommited |
| setOmitXMLDeclaration | | public void setOmitXMLDeclaration(boolean omit)(Code) | | Sets XML declaration omitting on and off.
Parameters:
omit - True if XML declaration should be ommited |
| setPreserveEmptyAttributes | | public void setPreserveEmptyAttributes(boolean preserve)(Code) | | Sets the preserveEmptyAttribute flag. If flag is false, then'
attributes with empty string values are output as the attribute
name only (in HTML mode).
Parameters:
preserve - the preserve flag |
| setPreserveSpace | | public void setPreserveSpace(boolean preserve)(Code) | | Sets space preserving as the default behavior. The default is
space stripping and all elements that do not specify otherwise
or use the default value will not preserve spaces.
Parameters:
preserve - True if spaces should be preserved |
| setStandalone | | public void setStandalone(boolean standalone)(Code) | | Sets document DTD standalone. The public and system
identifiers must be null for the document to be
serialized as standalone.
Parameters:
standalone - True if document DTD is standalone |
| setVersion | | public void setVersion(String version)(Code) | | Sets the version for this output method.
For XML the value would be "1.0", for HTML
it would be "4.0".
See Also: OutputFormat.getVersion
Parameters:
version - The output method version, or null |
| whichDoctypePublic | | public static String whichDoctypePublic(Document doc)(Code) | | Returns the document type public identifier
specified for this document, or null.
|
| whichDoctypeSystem | | public static String whichDoctypeSystem(Document doc)(Code) | | Returns the document type system identifier
specified for this document, or null.
|
| whichMediaType | | public static String whichMediaType(String method)(Code) | | Returns the suitable media format for a document
output with the specified method.
|
| whichMethod | | public static String whichMethod(Document doc)(Code) | | Determine the output method for the specified document.
If the document is an instance of
org.w3c.dom.html.HTMLDocument then the method is said to be html. If the root
element is 'html' and all text nodes preceding the root
element are all whitespace, then the method is said to be
html. Otherwise the method is xml.
Parameters:
doc - The document to check The suitable method |
|
|