getCDataElements
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.
getDoctypePublic
public String getDoctypePublic()
Returns the specified document type public identifier,
or null.
getDoctypeSystem
public String getDoctypeSystem()
Returns the specified document type system identifier,
or null.
getEncoding
public String getEncoding()
Returns the specified encoding. If no encoding was
specified, the default is always "UTF-8".
getEncodingInfo
public EncodingInfo getEncodingInfo()
throws UnsupportedEncodingException
Returns an EncodingInfo
instance for the encoding.
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.
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.
getLineSeparator
public 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).
- The specified line separator
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.
getMediaType
public String getMediaType()
Returns the specified media type, or null.
To determine the media type based on the
document type, use
whichMediaType(String)
.
- The specified media type, or null
getMethod
public String getMethod()
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
whichMethod(Document)
.
- The specified output method, or null
getNonEscapingElements
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.
getOmitComments
public boolean getOmitComments()
Returns true if comments should be ommited.
The default is false.
getOmitDocumentType
public boolean getOmitDocumentType()
Returns true if the DOCTYPE declaration should
be ommited. The default is false.
getOmitXMLDeclaration
public boolean getOmitXMLDeclaration()
Returns true if the XML document declaration should
be ommited. The default is false.
getPreserveEmptyAttributes
public boolean getPreserveEmptyAttributes()
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()
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()
Returns true if the document type is standalone.
The default is false.
getVersion
public 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.
- The specified method version, or null
isCDataElement
public boolean isCDataElement(String tagName)
Returns true if the text node children of the given elements
should be output as CDATA.
tagName
- The element's tag name
- True if should serialize as CDATA
isNonEscapingElement
public boolean isNonEscapingElement(String tagName)
Returns true if the text node children of the given elements
should be output unescaped.
tagName
- The element's tag name
- True if should serialize unescaped
setAllowJavaNames
public boolean setAllowJavaNames()
Returns whether java encoding names are permitted
setAllowJavaNames
public void setAllowJavaNames(boolean allow)
Sets whether java encoding names are permitted
setCDataElements
public void setCDataElements(String[] cdataElements)
Sets the list of elements for which text node children
should be output as CDATA.
cdataElements
- List of CDATA element tag names
setDoctype
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. Any document type specified
by the DOM Document or SAX events will override these
values.
publicId
- The public identifier, or nullsystemId
- The system identifier, or null
setEncoding
public void setEncoding(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 java.io.Writer
.
encoding
- The encoding, or null
setEncoding
public void setEncoding(EncodingInfo encInfo)
Sets the encoding for this output method with an EncodingInfo
instance.
setIndent
public void setIndent(int indent)
Sets the indentation. The document will not be
indented if the indentation is set to zero.
Calling
setIndenting(boolean)
will reset this
value to zero (off) or the default (on).
indent
- The indentation, or zero
setIndenting
public void setIndenting(boolean on)
on
- True if indentation should be on
setLineSeparator
public void setLineSeparator(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.
lineSeparator
- The specified line separator
setLineWidth
public void setLineWidth(int lineWidth)
Sets the line width. If zero then no line wrapping will
occur. Calling
setIndenting(boolean)
will reset this
value to zero (off) or the default (on).
lineWidth
- The line width to use, zero for default
setMediaType
public void setMediaType(String mediaType)
Sets the media type.
mediaType
- The specified media type
setMethod
public void setMethod(String method)
Sets the method for this output format.
method
- The output method, or null
setNonEscapingElements
public void setNonEscapingElements(String[] nonEscapingElements)
Sets the list of elements for which text node children
should be output unescaped (no character references).
nonEscapingElements
- List of unescaped element tag names
setOmitComments
public void setOmitComments(boolean omit)
Sets comment omitting on and off.
omit
- True if comments should be ommited
setOmitDocumentType
public void setOmitDocumentType(boolean omit)
Sets DOCTYPE declaration omitting on and off.
omit
- True if DOCTYPE declaration should be ommited
setOmitXMLDeclaration
public void setOmitXMLDeclaration(boolean omit)
Sets XML declaration omitting on and off.
omit
- True if XML declaration should be ommited
setPreserveEmptyAttributes
public void setPreserveEmptyAttributes(boolean preserve)
Sets 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
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.
preserve
- True if spaces should be preserved
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.
standalone
- True if document DTD is standalone
setVersion
public void setVersion(String version)
Sets the version for this output method.
For XML the value would be "1.0", for HTML
it would be "4.0".
version
- The output method version, or null
whichDoctypePublic
public static String whichDoctypePublic(org.w3c.dom.Document doc)
Returns the document type public identifier
specified for this document, or null.
whichDoctypeSystem
public static String whichDoctypeSystem(org.w3c.dom.Document doc)
Returns the document type system identifier
specified for this document, or null.
whichMediaType
public static String whichMediaType(String method)
Returns the suitable media format for a document
output with the specified method.
whichMethod
public static String whichMethod(org.w3c.dom.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. 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.
doc
- The document to check