OpenJDK 27 · com.sun.org.apache.xml.internal.serialize.XMLSerializer

Modifier and Type	Field and Description
protected static final boolean	DEBUG
protected NamespaceSupport	fLocalNSBinder stores all namespace bindings on the current element
protected boolean	fNamespacePrefixes Controls whether namespace prefixes will be printed out during serialization
protected boolean	fNamespaces Controls whether namespace fixup should be performed during the serialization.
protected NamespaceSupport	fNSBinder stores namespaces in scope
private boolean	fPreserveSpace
protected SymbolTable	fSymbolTable symbol table for serialization
protected static final String	PREFIX

Access	Constructor and Description
public	XMLSerializer() Constructs a new serializer.
public	XMLSerializer(OutputFormat format) References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. Constructs a new serializer.
public	XMLSerializer(Writer The writer to use writer, OutputFormat The output format to use, null for the default format) References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. Constructs a new serializer that writes to the specified writer using the specified output format.
public	XMLSerializer(OutputStream The output stream to use output, OutputFormat The output format to use, null for the default format) References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. Constructs a new serializer that writes to the specified output stream using the specified output format.

Method Summary

Modifier and Type	Method and Description
protected void	checkUnboundNamespacePrefixedNode(Node The node to check for unbound namespace prefices node) Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.checkUnboundNamespacePrefixedNode. DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.
public void	endElement(String namespaceURI, String localName, String rawName) Implements org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element.
public void	endElement(String tagName) Implements org.xml.sax.DocumentHandler.endElement. Receive notification of the end of an element.
public void	endElementIO(String namespaceURI, String localName, String rawName)
private Attributes	extractNamespaces(Attributes attrs) Retrieve and remove the namespaces declarations from the list of attributes.
protected String	getEntityRef(int ch) Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef. Returns the suitable entity reference for this character value, or null if no such entity exists.
private void	printAttribute(String name, String value, boolean isSpecified, Attr attr) Prints attribute.
protected void	printEscaped(String source) Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printEscaped. Escapes a string so it may be printed as text content or attribute value.
private void	printNamespaceAttr(String prefix, String uri) Serializes a namespace attribute with the given prefix and value for URI.
protected void	printText(String text, boolean preserveSpace, boolean unescaped) Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText.
protected void	printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText. Called to print additional text with whitespace handling.
protected void	printXMLChar(int ch) print text data
public boolean	reset() Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.reset.
protected void	serializeElement(Element elem) Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement. Called to serialize a DOM element.
public void	setNamespaces(boolean namespaces) This methods turns on namespace fixup algorithm during DOM serialization.
public void	setOutputFormat(OutputFormat format) Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.setOutputFormat. Implements com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat. References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. Specifies an output format for this serializer.
protected void	startDocument(String rootTagName) Called to serialize the document's DOCTYPE by the root element.
public void	startElement(String namespaceURI, String localName, String rawName, Attributes attrs) Implements org.xml.sax.ContentHandler.startElement. Receive notification of the beginning of an element.
public void	startElement(String tagName, AttributeList attrs) Implements org.xml.sax.DocumentHandler.startElement. References Deprecated `AttributeList` is deprecated or references (maybe indirectly) at least one deprecated element. Receive notification of the beginning of an element.

Inherited from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer:: asContentHandler asDocumentHandler asDOMSerializer attributeDecl characters characters cleanup clearDocumentState comment comment content elementDecl endCDATA endDocument endDTD endEntity endNonEscaping endPrefixMapping endPreserving enterElementState externalEntityDecl fatalError getElementState getPrefix ignorableWhitespace internalEntityDecl isDocumentState leaveElementState modifyDOMError notationDecl prepare printCDATAText printDoctypeURL printEscaped printHex processingInstruction processingInstructionIO serialize serialize serialize serialize serializeDocument serializeDTD serializeNode serializePreRoot setDocumentLocator setOutputByteStream setOutputCharStream skippedEntity startCDATA startDocument startDTD startEntity startNonEscaping startPrefixMapping startPreserving surrogates unparsedEntityDecl

Field Detail

DEBUG	back to summary
protected static final boolean DEBUG

fLocalNSBinder	back to summary
protected NamespaceSupport fLocalNSBinder stores all namespace bindings on the current element

fNamespacePrefixes	back to summary
protected boolean fNamespacePrefixes Controls whether namespace prefixes will be printed out during serialization

fNamespaces	back to summary
protected boolean fNamespaces Controls whether namespace fixup should be performed during the serialization. Note if this field is set to true the following fields need to be initialized: fNSBinder, fLocalNSBinder, fSymbolTable, XMLSymbols.EMPTY_STRING, fXmlSymbol, fXmlnsSymbol

fNSBinder	back to summary
protected NamespaceSupport fNSBinder stores namespaces in scope

fPreserveSpace	back to summary
private boolean fPreserveSpace

fSymbolTable	back to summary
protected SymbolTable fSymbolTable symbol table for serialization

PREFIX	back to summary
protected static final String PREFIX

Constructor Detail

XMLSerializer	back to summary
public XMLSerializer() Constructs a new serializer. The serializer cannot be used without calling `setOutputCharStream` or `setOutputByteStream` first.

XMLSerializer	back to summary
public XMLSerializer(OutputFormat format) References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Constructs a new serializer. The serializer cannot be used without calling `setOutputCharStream` or `setOutputByteStream` first.

XMLSerializer back to summary

XMLSerializer	back to summary
public XMLSerializer(Writer writer, OutputFormat format) References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Constructs a new serializer that writes to the specified writer using the specified output format. If `format` is null, will use a default output format. Parameters writer:Writer The writer to use format:OutputFormat The output format to use, null for the default

public XMLSerializer(Writer writer, OutputFormat format)

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.

Parameters

writer:Writer: The writer to use
format:OutputFormat: The output format to use, null for the default

XMLSerializer back to summary

XMLSerializer	back to summary
public XMLSerializer(OutputStream output, OutputFormat format) References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Constructs a new serializer that writes to the specified output stream using the specified output format. If `format` is null, will use a default output format. Parameters output:OutputStream The output stream to use format:OutputFormat The output format to use, null for the default

public XMLSerializer(OutputStream output, OutputFormat format)

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.

Parameters

output:OutputStream: The output stream to use
format:OutputFormat: The output format to use, null for the default

Method Detail

checkUnboundNamespacePrefixedNode	back to summary
protected void checkUnboundNamespacePrefixedNode(Node node) throws IOException Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.checkUnboundNamespacePrefixedNode. DOM Level 3: Check a node to determine if it contains unbound namespace prefixes. Parameters node:Node The node to check for unbound namespace prefices

checkUnboundNamespacePrefixedNode

back to summary

protected void checkUnboundNamespacePrefixedNode(Node node) throws IOException

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.checkUnboundNamespacePrefixedNode.

DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.

Parameters

node:Node: The node to check for unbound namespace prefices

endElement back to summary

endElement	back to summary
public void endElement(String namespaceURI, String localName, String rawName) throws SAXException Implements org.xml.sax.ContentHandler.endElement. Doc from org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element. The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding `startElement` event for every endElement event (even when the element is empty). For information on the names, see startElement. Exceptions SAXException: any SAX exception, possibly wrapping another exception

public void endElement(String namespaceURI, String localName, String rawName) throws SAXException

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.ContentHandler.endElement.

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement event for every endElement event (even when the element is empty).

For information on the names, see startElement.

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

endElement	back to summary
public void endElement(String tagName) throws SAXException Implements org.xml.sax.DocumentHandler.endElement. Doc from org.xml.sax.DocumentHandler.endElement. Receive notification of the end of an element. The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty). If the element name has a namespace prefix, the prefix will still be attached to the name. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

endElement

back to summary

public void endElement(String tagName) throws SAXException

Implements org.xml.sax.DocumentHandler.endElement.

Doc from org.xml.sax.DocumentHandler.endElement.

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

endElementIO	back to summary
public void endElementIO(String namespaceURI, String localName, String rawName) throws IOException

extractNamespaces	back to summary
private Attributes extractNamespaces(Attributes attrs) throws SAXException Retrieve and remove the namespaces declarations from the list of attributes.

getEntityRef back to summary

getEntityRef	back to summary
protected String getEntityRef(int ch) Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef. Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef. Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with `'&'` will return `"&"`.

protected String getEntityRef(int ch)

Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef.

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.getEntityRef.

Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".

printAttribute	back to summary
private void printAttribute(String name, String value, boolean isSpecified, Attr attr) throws IOException Prints attribute. Note xml:space attribute modifies output format

printEscaped back to summary

printEscaped	back to summary
protected void printEscaped(String source) throws IOException Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printEscaped. Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printEscaped. Escapes a string so it may be printed as text content or attribute value. Non printable characters are escaped using character references. Where the format specifies a deault entity reference, that reference is used (e.g. `<`).

protected void printEscaped(String source) throws IOException

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printEscaped.

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printEscaped.

Escapes a string so it may be printed as text content or attribute value. Non printable characters are escaped using character references. Where the format specifies a deault entity reference, that reference is used (e.g. <).

printNamespaceAttr	back to summary
private void printNamespaceAttr(String prefix, String uri) throws IOException Serializes a namespace attribute with the given prefix and value for URI. In case prefix is empty will serialize default namespace declaration.

printText	back to summary
protected void printText(String text, boolean preserveSpace, boolean unescaped) throws IOException Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText.

printText back to summary

printText	back to summary
protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText. Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText. Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling `printText(String, boolean, boolean)` with a call to `Printer#breakLine` for each new line. If spaces are not preserved, the text is broken at space boundaries if longer than the line width; Multiple spaces are printed as such, but spaces at beginning of line are removed.

protected void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) throws IOException

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText.

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.printText.

Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling printText(String, boolean, boolean) with a call to Printer#breakLine for each new line. If spaces are not preserved, the text is broken at space boundaries if longer than the line width; Multiple spaces are printed as such, but spaces at beginning of line are removed.

printXMLChar	back to summary
protected void printXMLChar(int ch) throws IOException print text data

reset	back to summary
public boolean reset() Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.reset.

serializeElement back to summary

serializeElement	back to summary
protected void serializeElement(Element elem) throws IOException Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement. Called to serialize a DOM element. Equivalent to calling `startElement`, `endElement` and serializing everything inbetween, but better optimized. Exceptions IOException: Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement. An I/O exception occured while serializing

protected void serializeElement(Element elem) throws IOException

Implements abstract com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement.

Called to serialize a DOM element. Equivalent to calling startElement, endElement and serializing everything inbetween, but better optimized.

Exceptions

IOException:

Doc from com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.serializeElement.

An I/O exception occured while serializing

setNamespaces back to summary

setNamespaces	back to summary
public void setNamespaces(boolean namespaces) This methods turns on namespace fixup algorithm during DOM serialization. See Also `org.w3c.dom.ls.LSSerializer`

public void setNamespaces(boolean namespaces)

This methods turns on namespace fixup algorithm during DOM serialization.

See Also: org.w3c.dom.ls.LSSerializer

setOutputFormat back to summary

setOutputFormat	back to summary
public void setOutputFormat(OutputFormat format) Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.setOutputFormat. Implements com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat. Doc from com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat. References Deprecated `OutputFormat` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.

public void setOutputFormat(OutputFormat format)

Overrides com.sun.org.apache.xml.internal.serialize.BaseMarkupSerializer.setOutputFormat.

Implements com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat.

Doc from com.sun.org.apache.xml.internal.serialize.Serializer.setOutputFormat.

References Deprecated

OutputFormat is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.

startDocument back to summary

startDocument	back to summary
protected void startDocument(String rootTagName) throws IOException Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document. This method will check if it has not been called before (`_started`), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see `serializePreRoot`). Pre-root will be serialized even if this is not the first root element of the document.

protected void startDocument(String rootTagName) throws IOException

Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.

This method will check if it has not been called before (_started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see serializePreRoot). Pre-root will be serialized even if this is not the first root element of the document.

startElement back to summary

startElement	back to summary
public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException Implements org.xml.sax.ContentHandler.startElement. Doc from org.xml.sax.ContentHandler.startElement. Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding `endElement` event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event. This event allows up to three name components for each element: the Namespace URI; the local name; and the qualified (prefixed) name. Any or all of these may be provided, depending on the values of the `http://xml.org/sax/features/namespaces` and the `http://xml.org/sax/features/namespace-prefixes` properties: the Namespace URI and local name are required when the namespaces property is `true` (the default), and are optional when the namespaces property is `false` (if one is specified, both must be); the qualified name is required when the namespace-prefixes property is `true`, and is optional when the namespace-prefixes property is `false` (the default). Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the `http://xml.org/sax/features/namespace-prefixes` property is true (it is false by default, and support for a true value is optional). Like `characters()`, attribute values may have characters that need more than one `char` value. Exceptions SAXException: any SAX exception, possibly wrapping another exception

public void startElement(String namespaceURI, String localName, String rawName, Attributes attrs) throws SAXException

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.ContentHandler.startElement.

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

This event allows up to three name components for each element:

the Namespace URI;
the local name; and
the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:

the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes property is true (it is false by default, and support for a true value is optional).

Like characters(), attribute values may have characters that need more than one char value.

Exceptions

SAXException:: any SAX exception, possibly wrapping another exception

startElement back to summary

startElement	back to summary
public void startElement(String tagName, AttributeList attrs) throws SAXException Implements org.xml.sax.DocumentHandler.startElement. Doc from org.xml.sax.DocumentHandler.startElement. References Deprecated `AttributeList` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event. If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. Exceptions SAXException: Any SAX exception, possibly wrapping another exception.

public void startElement(String tagName, AttributeList attrs) throws SAXException

Implements org.xml.sax.DocumentHandler.startElement.

Doc from org.xml.sax.DocumentHandler.startElement.

References Deprecated

AttributeList is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

public Class XMLSerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail