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:
for the specified method (XML, HTML, Text, etc), encoding and indentation
compatible with the document type (XML, HTML, Text, etc), encoding and
indentation
Version:
$Revision: 1.9 $ $Date: 2000/08/30 18:59:21 $
Inner Class Summary
static class
static class
Constructor Summary
Constructs a new output format with the default values.
Constructs a new output format with the proper method,
document type identifiers and media type for the specified
document.
java.lang.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.
java.lang.String encoding,
boolean indenting)
Constructs a new output format with the default values for
the specified method and encoding.
Method Summary
java.lang.String[]
Returns a list of all the elements whose text node children
should be output as CDATA, or null if no such elements were
specified.
java.lang.String
Returns the specified document type public identifier,
or null.
java.lang.String
Returns the specified document type system identifier,
or null.
java.lang.String
Returns the specified encoding.
int
Returns the indentation specified.
boolean
Returns true if indentation was specified.
char
Returns the last printable character based on the selected
encoding.
java.lang.String
Returns a specific line separator to use.
int
Return the selected line width for breaking up long lines.
java.lang.String
Returns the specified media type, or null.
java.lang.String
Returns the method specified for this output format.
java.lang.String[]
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.
boolean
Returns true if comments should be ommited.
boolean
Returns true if the DOCTYPE declaration should
be ommited.
boolean
Returns true if the XML document declaration should
be ommited.
boolean
Returns true if the default behavior for this format is to
preserve spaces.
boolean
Returns true if the document type is standalone.
java.lang.String
Returns the version for this output method.
boolean
Returns true if the text node children of the given elements
should be output as CDATA.
boolean
Returns true if the text node children of the given elements
should be output unescaped.
void
Sets the list of elements for which text node children
should be output as CDATA.
void
java.lang.String systemId)
Sets the document type public and system identifiers.
void
Sets the encoding for this output method.
void
Sets the indentation.
void
Sets the indentation on and off.
void
Sets the line separator.
void
Sets the line width.
void
Sets the media type.
void
Sets the method for this output format.
void
Sets the list of elements for which text node children
should be output unescaped (no character references).
void
Sets comment omitting on and off.
void
Sets DOCTYPE declaration omitting on and off.
void
Sets XML declaration omitting on and off.
void
Sets space preserving as the default behavior.
void
Sets document DTD standalone.
void
Sets the version for this output method.
static java.lang.String
Returns the document type public identifier
specified for this document, or null.
static java.lang.String
Returns the document type system identifier
specified for this document, or null.
static java.lang.String
Returns the suitable media format for a document
output with the specified method.
static java.lang.String
Determine the output method for the specified document.
Constructs a new output format with the default values.
OutputFormat
public OutputFormat(java.lang.String method,
java.lang.String encoding,
boolean indenting)
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.
Constructs a new output format with the proper method,
document type identifiers and media type for the specified
document.
OutputFormat
public OutputFormat(Document doc,
java.lang.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. If indent
is true, the document will be pretty printed with the default
indentation level and default line wrapping.
Method Detail
getMethod
public java.lang.String getMethod()
Returns the method specified for this output format.
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
Returns:
The specified output method, or null
setMethod
public void setMethod(java.lang.String method)
Sets the method for this output format.
getVersion
public java.lang.String getVersion()
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.
Returns:
The specified method version, or null
setVersion
public void setVersion(java.lang.String version)
Sets the version for this output method.
For XML the value would be "1.0", for HTML
it would be "4.0".
getIndent
public int getIndent()
Returns the indentation specified. If no indentation
was specified, zero is returned and the document
should not be indented.
getIndenting
public boolean getIndenting()
Returns true if indentation was specified.
setIndent
public void setIndent(int indent)
Sets the indentation. The document will not be
indented if the indentation is set to zero.
value to zero (off) or the default (on).
Parameters:
indent - The indentation, or zero
setIndenting
public void setIndenting(boolean on)
Sets the indentation on and off. When set on, the default
indentation level and default line wrapping is used
(see #DEFAULT_INDENT and #DEFAULT_LINE_WIDTH).
To specify a different indentation level or line wrapping,
Parameters:
on - True if indentation should be on
getEncoding
public java.lang.String getEncoding()
Returns the specified encoding. If no encoding was
specified, the default is always "UTF-8".
Returns:
The encoding
setEncoding
public void setEncoding(java.lang.String encoding)
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 Writer.
getMediaType
public java.lang.String getMediaType()
Returns the specified media type, or null.
To determine the media type based on the
Returns:
The specified media type, or null
setMediaType
public void setMediaType(java.lang.String mediaType)
Sets the media type.
setDoctype
public void setDoctype(java.lang.String publicId,
java.lang.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. Any document type specified
by the DOM Document or SAX events will override these
values.
Parameters:
publicId - The public identifier, or null
systemId - The system identifier, or null
getDoctypePublic
public java.lang.String getDoctypePublic()
Returns the specified document type public identifier,
or null.
getDoctypeSystem
public java.lang.String getDoctypeSystem()
Returns the specified document type system identifier,
or null.
getOmitComments
public boolean getOmitComments()
Returns true if comments should be ommited.
The default is false.
setOmitComments
public void setOmitComments(boolean omit)
Sets comment omitting on and off.
Parameters:
omit - True if comments should be ommited
getOmitDocumentType
public boolean getOmitDocumentType()
Returns true if the DOCTYPE declaration should
be ommited. The default is false.
setOmitDocumentType
public void setOmitDocumentType(boolean omit)
Sets DOCTYPE declaration omitting on and off.
Parameters:
omit - True if DOCTYPE declaration should be ommited
getOmitXMLDeclaration
public boolean getOmitXMLDeclaration()
Returns true if the XML document declaration should
be ommited. The default is false.
setOmitXMLDeclaration
public void setOmitXMLDeclaration(boolean omit)
Sets XML declaration omitting on and off.
Parameters:
omit - True if XML declaration should be ommited
getStandalone
public boolean getStandalone()
Returns true if the document type is standalone.
The default is false.
setStandalone
public void setStandalone(boolean standalone)
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
getCDataElements
public java.lang.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.
isCDataElement
public boolean isCDataElement(java.lang.String tagName)
Returns true if the text node children of the given elements
should be output as CDATA.
Parameters:
tagName - The element's tag name
Returns:
True if should serialize as CDATA
setCDataElements
public void setCDataElements(java.lang.String[] cdataElements)
Sets the list of elements for which text node children
should be output as CDATA.
Parameters:
cdataElements - List of CDATA element tag names
getNonEscapingElements
public java.lang.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.
isNonEscapingElement
public boolean isNonEscapingElement(java.lang.String tagName)
Returns true if the text node children of the given elements
should be output unescaped.
Parameters:
tagName - The element's tag name
Returns:
True if should serialize unescaped
setNonEscapingElements
public void setNonEscapingElements(java.lang.String[] nonEscapingElements)
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
getLineSeparator
public java.lang.String getLineSeparator()
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).
Returns:
The specified line separator
setLineSeparator
public void setLineSeparator(java.lang.String lineSeparator)
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
getPreserveSpace
public boolean getPreserveSpace()
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.
setPreserveSpace
public void setPreserveSpace(boolean preserve)
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
getLineWidth
public int getLineWidth()
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.
setLineWidth
public void setLineWidth(int lineWidth)
Sets the line width. If zero then no line wrapping will
value to zero (off) or the default (on).
getLastPrintable
public char getLastPrintable()
Returns the last printable character based on the selected
encoding. Control characters and non-printable characters
are always printed as character references.
whichMethod
public static java.lang.String whichMethod(Document doc)
Determine the output method for the specified document.
If the document is an instance of 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
Parameters:
doc - The document to check
Returns:
The suitable method
whichDoctypePublic
public static java.lang.String whichDoctypePublic(Document doc)
Returns the document type public identifier
specified for this document, or null.
whichDoctypeSystem
public static java.lang.String whichDoctypeSystem(Document doc)
Returns the document type system identifier
specified for this document, or null.
whichMediaType
public static java.lang.String whichMediaType(java.lang.String method)
Returns the suitable media format for a document
output with the specified method.
