OpenJDK 1.23 · com.sun.org.apache.xml.internal.serializer.SerializationHandler

Method Summary

Modifier and Type	Method and Description
public void	close()
public void	flushPending() A SerializationHandler accepts SAX-like events, so it can accumulate attributes or namespace nodes after a startElement().
public Transformer	Returns: Transformer the transformer associated with the serializer. getTransformer() Get the transformer associated with the serializer.
public void	serialize(Node the DOM node to be serialized. node) Redeclares com.sun.org.apache.xml.internal.serializer.DOMSerializer.serialize. Notify that the serializer should take this DOM node as input to be serialized.
public void	setContentHandler(ContentHandler ch) Set the SAX Content handler that the serializer sends its output to.
public void	setDTDEntityExpansion(boolean true if DTD entities are to be expanded, false if they are to be left as DTD entity references. expand) Default behavior is to expand DTD entities, that is the initall default value is true.
public boolean	setEscaping(boolean true if escaping is to be set on. escape) Turns special character escaping on/off.
public void	setIndentAmount(int the number of spaces to indent for each indentation level. spaces) Set the number of spaces to indent for each indentation level.
public void	setIsStandalone(boolean true if the property "jdk.xml.xsltcIsStandalone" is set to yes b) Specify if the output will be treated as a standalone property
public void	setNamespaceMappings(NamespaceMappings NamespaceMappings mappings) Used only by TransformerSnapshotImpl to restore the serialization to a previous state.
public void	setTransformer(Transformer the transformer associated with the serializer. transformer) Set the transformer associated with the serializer.

Inherited from com.sun.org.apache.xml.internal.serializer.ExtendedContentHandler:: addAttribute addAttribute addAttribute addAttributes addUniqueAttribute addXSLAttribute characters characters endElement entityReference getNamespaceMappings getNamespaceURI getNamespaceURIFromPrefix getPrefix namespaceAfterStartElement setSourceLocator startElement startElement startPrefixMapping
Inherited from com.sun.org.apache.xml.internal.serializer.ExtendedLexicalHandler:: comment
Inherited from com.sun.org.apache.xml.internal.serializer.Serializer:: asContentHandler asDOM3Serializer asDOMSerializer getOutputFormat getOutputStream getWriter reset setOutputFormat setOutputStream setWriter
Inherited from com.sun.org.apache.xml.internal.serializer.XSLOutputAttributes:: getDoctypePublic getDoctypeSystem getEncoding getIndent getIndentAmount getMediaType getOmitXMLDeclaration getOutputProperty getOutputPropertyDefault getStandalone getVersion setCdataSectionElements setDoctype setDoctypePublic setDoctypeSystem setEncoding setIndent setMediaType setOmitXMLDeclaration setOutputProperty setOutputPropertyDefault setStandalone setVersion
Inherited from org.xml.sax.DTDHandler:: notationDecl unparsedEntityDecl
Inherited from org.xml.sax.ErrorHandler:: error fatalError warning
Inherited from org.xml.sax.ext.DeclHandler:: attributeDecl elementDecl externalEntityDecl internalEntityDecl

Method Detail

close	back to summary
public void close()

flushPending	back to summary
public void flushPending() throws SAXException A SerializationHandler accepts SAX-like events, so it can accumulate attributes or namespace nodes after a startElement(). If the SerializationHandler has a Writer or OutputStream, a call to this method will flush such accumulated events as a closed start tag for an element. If the SerializationHandler wraps a ContentHandler, a call to this method will flush such accumulated events as a SAX (not SAX-like) calls to startPrefixMapping() and startElement(). If one calls endDocument() then one need not call this method since a call to endDocument() will do what this method does. However, in some circumstances, such as with document fragments, endDocument() is not called and it may be necessary to call this method to flush any pending events. For performance reasons this method should not be called very often.

flushPending

back to summary

public void flushPending() throws SAXException

A SerializationHandler accepts SAX-like events, so it can accumulate attributes or namespace nodes after a startElement().

If the SerializationHandler has a Writer or OutputStream, a call to this method will flush such accumulated events as a closed start tag for an element.

If the SerializationHandler wraps a ContentHandler, a call to this method will flush such accumulated events as a SAX (not SAX-like) calls to startPrefixMapping() and startElement().

If one calls endDocument() then one need not call this method since a call to endDocument() will do what this method does. However, in some circumstances, such as with document fragments, endDocument() is not called and it may be necessary to call this method to flush any pending events.

For performance reasons this method should not be called very often.

getTransformer	back to summary
public Transformer getTransformer() Get the transformer associated with the serializer. Returns:Transformer Transformer the transformer associated with the serializer.

getTransformer

back to summary

public Transformer getTransformer()

Get the transformer associated with the serializer.

Returns:Transformer: Transformer the transformer associated with the serializer.

serialize	back to summary
public void serialize(Node node) throws IOException Redeclares com.sun.org.apache.xml.internal.serializer.DOMSerializer.serialize. Notify that the serializer should take this DOM node as input to be serialized. Parameters node:Node the DOM node to be serialized. Exceptions IOException: Doc from com.sun.org.apache.xml.internal.serializer.DOMSerializer.serialize. if an I/O exception occured while serializing

serialize

back to summary

public void serialize(Node node) throws IOException

Redeclares com.sun.org.apache.xml.internal.serializer.DOMSerializer.serialize.

Notify that the serializer should take this DOM node as input to be serialized.

Parameters

node:Node: the DOM node to be serialized.

Exceptions

IOException:

Doc from com.sun.org.apache.xml.internal.serializer.DOMSerializer.serialize.

if an I/O exception occured while serializing

setContentHandler back to summary

setContentHandler	back to summary
public void setContentHandler(ContentHandler ch) Set the SAX Content handler that the serializer sends its output to. This method only applies to a ToSAXHandler, not to a ToStream serializer. See Also `Serializer#asContentHandler()`, `ToSAXHandler`

public void setContentHandler(ContentHandler ch)

Set the SAX Content handler that the serializer sends its output to. This method only applies to a ToSAXHandler, not to a ToStream serializer.

See Also: Serializer#asContentHandler(), ToSAXHandler

setDTDEntityExpansion	back to summary
public void setDTDEntityExpansion(boolean expand) Default behavior is to expand DTD entities, that is the initall default value is true. Parameters expand:boolean true if DTD entities are to be expanded, false if they are to be left as DTD entity references.

setDTDEntityExpansion

back to summary

public void setDTDEntityExpansion(boolean expand)

Default behavior is to expand DTD entities, that is the initall default value is true.

Parameters

expand:boolean: true if DTD entities are to be expanded, false if they are to be left as DTD entity references.

setEscaping	back to summary
public boolean setEscaping(boolean escape) throws SAXException Turns special character escaping on/off. Note that characters will never, even if this option is set to 'true', be escaped within CDATA sections in output XML documents. Parameters escape:boolean true if escaping is to be set on.

setEscaping

back to summary

public boolean setEscaping(boolean escape) throws SAXException

Turns special character escaping on/off. Note that characters will never, even if this option is set to 'true', be escaped within CDATA sections in output XML documents.

Parameters

escape:boolean: true if escaping is to be set on.

setIndentAmount	back to summary
public void setIndentAmount(int spaces) Set the number of spaces to indent for each indentation level. Parameters spaces:int the number of spaces to indent for each indentation level.

setIndentAmount

back to summary

public void setIndentAmount(int spaces)

Set the number of spaces to indent for each indentation level.

Parameters

spaces:int: the number of spaces to indent for each indentation level.

setIsStandalone back to summary

setIsStandalone	back to summary
public void setIsStandalone(boolean b) Specify if the output will be treated as a standalone property Parameters b:boolean true if the property "jdk.xml.xsltcIsStandalone" is set to yes See Also `JdkConstants.SP_XSLTC_IS_Standalone`

public void setIsStandalone(boolean b)

Specify if the output will be treated as a standalone property

Parameters

b:boolean: true if the property "jdk.xml.xsltcIsStandalone" is set to yes

See Also

JdkConstants.SP_XSLTC_IS_Standalone

setNamespaceMappings	back to summary
public void setNamespaceMappings(NamespaceMappings mappings) Used only by TransformerSnapshotImpl to restore the serialization to a previous state. Parameters mappings:NamespaceMappings NamespaceMappings

setNamespaceMappings

back to summary

public void setNamespaceMappings(NamespaceMappings mappings)

Used only by TransformerSnapshotImpl to restore the serialization to a previous state.

Parameters

mappings:NamespaceMappings: NamespaceMappings

setTransformer	back to summary
public void setTransformer(Transformer transformer) Set the transformer associated with the serializer. Parameters transformer:Transformer the transformer associated with the serializer.

setTransformer

back to summary

public void setTransformer(Transformer transformer)

Set the transformer associated with the serializer.

Parameters

transformer:Transformer: the transformer associated with the serializer.

public Interface SerializationHandler

Field Summary

Method Summary

Method Detail