OpenJDK 1.23 · com.sun.org.apache.xml.internal.serializer.dom3.LSSerializerImpl

Modifier and Type	Field and Description
private static final int	CANONICAL
private static final int	CDATA
private static final int	CHARNORMALIZE
private static final int	COMMENTS
private static final int	DISCARDDEFAULT
private static final int	DTNORMALIZE
private static final int	ELEM_CONTENT_WHITESPACE
private static final int	ENTITIES
private Properties	fDOMConfigProperties
private DOMErrorHandler	fDOMErrorHandler
private DOM3Serializer	fDOMSerializer
private String	fEncoding
private String	fEndOfLine
protected int	fFeatures
private JdkProperty<Boolean>	fIsStandalone
private String[]	fRecognizedParameters
private LSSerializerFilter	fSerializerFilter
private Node	fVisitedNode
private Serializer	fXMLSerializer private data members
private static final int	IGNORE_CHAR_DENORMALIZE
private static final int	INFOSET
private static final int	IS_STANDALONE
private static final int	NAMESPACEDECLS
private static final int	NAMESPACES
private static final int	NORMALIZECHARS
private static final int	PRETTY_PRINT
private static final int	SCHEMAVALIDATE
private static final int	SPLITCDATA
private static final int	VALIDATE
private static final int	WELLFORMED
private static final int	XMLDECL

Access	Constructor and Description
public	LSSerializerImpl() Constructor: Creates a LSSerializerImpl object.

Method Summary

Modifier and Type	Method and Description
public boolean	canSetParameter(String A String containing the DOMConfiguration parameter name. name, Object An Object specifying the value of the corresponding parameter. value) Implements org.w3c.dom.DOMConfiguration.canSetParameter. Checks if setting a parameter to a specific value is supported.
public DOMConfiguration	Returns: A DOMConfiguration object. getDomConfig() Implements org.w3c.dom.ls.LSSerializer.getDomConfig. Returns the DOMConfiguration of the LSSerializer.
public DOMErrorHandler	Returns: Returns the fDOMErrorHandler. getErrorHandler() This method returns the LSSerializer's error handler.
public LSSerializerFilter	Returns: A LSSerializerFilter object. getFilter() Implements org.w3c.dom.ls.LSSerializer.getFilter. Returns the DOMConfiguration of the LSSerializer.
protected String	Returns: A String containing the input encoding. getInputEncoding(Node The Node to serialize nodeArg) Determines the Input Encoding of the Document Node to serialize.
public String	Returns: A String containing the end-of-line character sequence used in serialization. getNewLine() Implements org.w3c.dom.ls.LSSerializer.getNewLine. Returns the End-Of-Line sequence of characters to be used in the XML being serialized.
public Object	Returns: Object The value of the parameter if known. getParameter(String A String containing the DOMConfiguration parameter name whose value is to be returned. name) Implements org.w3c.dom.DOMConfiguration.getParameter. This method returns the value of a parameter if known.
public DOMStringList	Returns: DOMStringList A list of DOMConfiguration parameters recognized by the serializer getParameterNames() Implements org.w3c.dom.DOMConfiguration.getParameterNames. This method returns a of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application
protected String	Returns: A String containing the encoding pseudo-attribute of the XMLDecl. getXMLEncoding(Node The Node to serialize nodeArg) Determines the XML Encoding of the Document Node to serialize.
protected String	Returns: A String containing the version pseudo-attribute of the XMLDecl. getXMLVersion(Node The Node to serialize nodeArg) Determines the XML Version of the Document Node to serialize.
public void	initializeSerializerProps() Initializes the underlying serializer's configuration depending on the default DOMConfiguration parameters.
public void	setFilter(LSSerializerFilter A LSSerializerFilter to be applied to the stream to serialize. filter) Implements org.w3c.dom.ls.LSSerializer.setFilter. Set a LSSerilizerFilter on the LSSerializer.
public void	setNewLine(String a String that is the end-of-line character sequence to be used in serialization. newLine) Implements org.w3c.dom.ls.LSSerializer.setNewLine. Sets the End-Of-Line sequence of characters to be used in the XML being serialized.
public void	setParameter(String A String containing the DOMConfiguration parameter name. name, Object An Object contaiing the parameters value to set. value) Implements org.w3c.dom.DOMConfiguration.setParameter. This method sets the value of the named parameter.
public boolean	write(Node The Node to serialize. nodeArg, LSOutput The destination for the serialized DOM. destination) Implements org.w3c.dom.ls.LSSerializer.write. Serializes the specified node to the specified LSOutput and returns true if the Node was successfully serialized.
public String	writeToString(Node The Node to serialize. nodeArg) Implements org.w3c.dom.ls.LSSerializer.writeToString. Serializes the specified node and returns a String with the serialized data to the caller.
public boolean	writeToURI(Node The Node to serialize. nodeArg, String The URI to write to. uri) Implements org.w3c.dom.ls.LSSerializer.writeToURI. Serializes the specified node to the specified URI and returns true if the Node was successfully serialized.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

CANONICAL	back to summary
private static final int CANONICAL

CDATA	back to summary
private static final int CDATA

CHARNORMALIZE	back to summary
private static final int CHARNORMALIZE

COMMENTS	back to summary
private static final int COMMENTS

DISCARDDEFAULT	back to summary
private static final int DISCARDDEFAULT

DTNORMALIZE	back to summary
private static final int DTNORMALIZE

ELEM_CONTENT_WHITESPACE	back to summary
private static final int ELEM_CONTENT_WHITESPACE

ENTITIES	back to summary
private static final int ENTITIES

fDOMConfigProperties	back to summary
private Properties fDOMConfigProperties

fDOMErrorHandler	back to summary
private DOMErrorHandler fDOMErrorHandler

fDOMSerializer	back to summary
private DOM3Serializer fDOMSerializer

fEncoding	back to summary
private String fEncoding

fEndOfLine	back to summary
private String fEndOfLine

fFeatures	back to summary
protected int fFeatures

fIsStandalone	back to summary
private JdkProperty<Boolean> fIsStandalone

fRecognizedParameters	back to summary
private String[] fRecognizedParameters Annotations @SuppressWarnings:deprecation

fSerializerFilter	back to summary
private LSSerializerFilter fSerializerFilter

fVisitedNode	back to summary
private Node fVisitedNode

fXMLSerializer	back to summary
private Serializer fXMLSerializer private data members

IGNORE_CHAR_DENORMALIZE	back to summary
private static final int IGNORE_CHAR_DENORMALIZE

INFOSET	back to summary
private static final int INFOSET

IS_STANDALONE	back to summary
private static final int IS_STANDALONE

NAMESPACEDECLS	back to summary
private static final int NAMESPACEDECLS

NAMESPACES	back to summary
private static final int NAMESPACES

NORMALIZECHARS	back to summary
private static final int NORMALIZECHARS

PRETTY_PRINT	back to summary
private static final int PRETTY_PRINT

SCHEMAVALIDATE	back to summary
private static final int SCHEMAVALIDATE

SPLITCDATA	back to summary
private static final int SPLITCDATA

VALIDATE	back to summary
private static final int VALIDATE

WELLFORMED	back to summary
private static final int WELLFORMED

XMLDECL	back to summary
private static final int XMLDECL

LSSerializerImpl	back to summary
public LSSerializerImpl() Constructor: Creates a LSSerializerImpl object. The underlying XML 1.0 or XML 1.1 org.apache.xml.serializer.Serializer object is created and initialized the first time any of the write methods are invoked to serialize the Node. Subsequent write methods on the same LSSerializerImpl object will use the previously created Serializer object.

Method Detail

canSetParameter back to summary

canSetParameter	back to summary
public boolean canSetParameter(String name, Object value) Implements org.w3c.dom.DOMConfiguration.canSetParameter. Checks if setting a parameter to a specific value is supported. Parameters name:String A String containing the DOMConfiguration parameter name. value:Object An Object specifying the value of the corresponding parameter. Returns:boolean Doc from org.w3c.dom.DOMConfiguration.canSetParameter. `true` if the parameter could be successfully set to the specified value, or `false` if the parameter is not recognized or the requested value is not supported. This does not change the current value of the parameter itself. Annotations @SuppressWarnings:deprecation Since DOM Level 3 See Also `org.w3c.dom.DOMConfiguration#canSetParameter(java.lang.String, java.lang.Object)`

public boolean canSetParameter(String name, Object value)

Implements org.w3c.dom.DOMConfiguration.canSetParameter.

Checks if setting a parameter to a specific value is supported.

Parameters

name:String: A String containing the DOMConfiguration parameter name.
value:Object: An Object specifying the value of the corresponding parameter.

Returns:boolean

Doc from org.w3c.dom.DOMConfiguration.canSetParameter.

true if the parameter could be successfully set to the specified value, or false if the parameter is not recognized or the requested value is not supported. This does not change the current value of the parameter itself.

Annotations

@SuppressWarnings:deprecation

Since

DOM Level 3

getDomConfig back to summary

getDomConfig	back to summary
public DOMConfiguration getDomConfig() Implements org.w3c.dom.ls.LSSerializer.getDomConfig. Returns the DOMConfiguration of the LSSerializer. Returns:DOMConfiguration A DOMConfiguration object. Since DOM Level 3 See Also `org.w3c.dom.ls.LSSerializer#getDomConfig()`

public DOMConfiguration getDomConfig()

Implements org.w3c.dom.ls.LSSerializer.getDomConfig.

Returns the DOMConfiguration of the LSSerializer.

Returns:DOMConfiguration: A DOMConfiguration object.
Since: DOM Level 3
See Also: org.w3c.dom.ls.LSSerializer#getDomConfig()

getErrorHandler	back to summary
public DOMErrorHandler getErrorHandler() This method returns the LSSerializer's error handler. Returns:DOMErrorHandler Returns the fDOMErrorHandler.

getErrorHandler

back to summary

public DOMErrorHandler getErrorHandler()

This method returns the LSSerializer's error handler.

Returns:DOMErrorHandler: Returns the fDOMErrorHandler.

getFilter back to summary

getFilter	back to summary
public LSSerializerFilter getFilter() Implements org.w3c.dom.ls.LSSerializer.getFilter. Returns the DOMConfiguration of the LSSerializer. Returns:LSSerializerFilter A LSSerializerFilter object. Since DOM Level 3 See Also `org.w3c.dom.ls.LSSerializer#getFilter()`

public LSSerializerFilter getFilter()

Implements org.w3c.dom.ls.LSSerializer.getFilter.

Returns the DOMConfiguration of the LSSerializer.

Returns:LSSerializerFilter: A LSSerializerFilter object.
Since: DOM Level 3
See Also: org.w3c.dom.ls.LSSerializer#getFilter()

getInputEncoding	back to summary
protected String getInputEncoding(Node nodeArg) Determines the Input Encoding of the Document Node to serialize. If the Document Node is not a DOM Level 3 Node, then null is returned. Parameters nodeArg:Node The Node to serialize Returns:String A String containing the input encoding.

getInputEncoding

back to summary

protected String getInputEncoding(Node nodeArg)

Determines the Input Encoding of the Document Node to serialize. If the Document Node is not a DOM Level 3 Node, then null is returned.

Parameters

nodeArg:Node: The Node to serialize

Returns:String

A String containing the input encoding.

getNewLine back to summary

getNewLine	back to summary
public String getNewLine() Implements org.w3c.dom.ls.LSSerializer.getNewLine. Returns the End-Of-Line sequence of characters to be used in the XML being serialized. If none is set a default "\n" is returned. Returns:String A String containing the end-of-line character sequence used in serialization. Since DOM Level 3 See Also `org.w3c.dom.ls.LSSerializer#getNewLine()`

public String getNewLine()

Implements org.w3c.dom.ls.LSSerializer.getNewLine.

Returns the End-Of-Line sequence of characters to be used in the XML being serialized. If none is set a default "\n" is returned.

Returns:String: A String containing the end-of-line character sequence used in serialization.
Since: DOM Level 3
See Also: org.w3c.dom.ls.LSSerializer#getNewLine()

getParameter back to summary

getParameter	back to summary
public Object getParameter(String name) throws DOMException Implements org.w3c.dom.DOMConfiguration.getParameter. This method returns the value of a parameter if known. Parameters name:String A String containing the DOMConfiguration parameter name whose value is to be returned. Returns:Object Object The value of the parameter if known. Exceptions DOMException: Doc from org.w3c.dom.DOMConfiguration.getParameter. NOT_FOUND_ERR: Raised when the parameter name is not recognized. See Also `org.w3c.dom.DOMConfiguration#getParameter(java.lang.String)`

public Object getParameter(String name) throws DOMException

Implements org.w3c.dom.DOMConfiguration.getParameter.

This method returns the value of a parameter if known.

Parameters

name:String: A String containing the DOMConfiguration parameter name whose value is to be returned.

Returns:Object

Object The value of the parameter if known.

Exceptions

DOMException:

Doc from org.w3c.dom.DOMConfiguration.getParameter.

NOT_FOUND_ERR: Raised when the parameter name is not recognized.

getParameterNames back to summary

getParameterNames	back to summary
public DOMStringList getParameterNames() Implements org.w3c.dom.DOMConfiguration.getParameterNames. This method returns a of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application Returns:DOMStringList DOMStringList A list of DOMConfiguration parameters recognized by the serializer See Also `org.w3c.dom.DOMConfiguration#getParameterNames()`

public DOMStringList getParameterNames()

Implements org.w3c.dom.DOMConfiguration.getParameterNames.

This method returns a of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application

Returns:DOMStringList: DOMStringList A list of DOMConfiguration parameters recognized by the serializer
See Also: org.w3c.dom.DOMConfiguration#getParameterNames()

getXMLEncoding	back to summary
protected String getXMLEncoding(Node nodeArg) Determines the XML Encoding of the Document Node to serialize. If the Document Node is not a DOM Level 3 Node, then the default encoding "UTF-8" is returned. Parameters nodeArg:Node The Node to serialize Returns:String A String containing the encoding pseudo-attribute of the XMLDecl. Exceptions Throwable: if the DOM implementation does not implement Document.getXmlEncoding()

getXMLEncoding

back to summary

protected String getXMLEncoding(Node nodeArg)

Determines the XML Encoding of the Document Node to serialize. If the Document Node is not a DOM Level 3 Node, then the default encoding "UTF-8" is returned.

Parameters

nodeArg:Node: The Node to serialize

Returns:String

A String containing the encoding pseudo-attribute of the XMLDecl.

Exceptions

Throwable:: if the DOM implementation does not implement Document.getXmlEncoding()

getXMLVersion	back to summary
protected String getXMLVersion(Node nodeArg) Determines the XML Version of the Document Node to serialize. If the Document Node is not a DOM Level 3 Node, then the default version returned is 1.0. Parameters nodeArg:Node The Node to serialize Returns:String A String containing the version pseudo-attribute of the XMLDecl. Exceptions Throwable: if the DOM implementation does not implement Document.getXmlVersion()

getXMLVersion

back to summary

protected String getXMLVersion(Node nodeArg)

Determines the XML Version of the Document Node to serialize. If the Document Node is not a DOM Level 3 Node, then the default version returned is 1.0.

Parameters

nodeArg:Node: The Node to serialize

Returns:String

A String containing the version pseudo-attribute of the XMLDecl.

Exceptions

Throwable:: if the DOM implementation does not implement Document.getXmlVersion()

initializeSerializerProps	back to summary
public void initializeSerializerProps() Initializes the underlying serializer's configuration depending on the default DOMConfiguration parameters. This method must be called before a node is to be serialized.

setFilter back to summary

setFilter	back to summary
public void setFilter(LSSerializerFilter filter) Implements org.w3c.dom.ls.LSSerializer.setFilter. Set a LSSerilizerFilter on the LSSerializer. When set, the filter is called before each node is serialized which depending on its implemention determines if the node is to be serialized or not. Parameters filter:LSSerializerFilter A LSSerializerFilter to be applied to the stream to serialize. Since DOM Level 3 See Also `org.w3c.dom.ls.LSSerializer#setFilter`

public void setFilter(LSSerializerFilter filter)

Implements org.w3c.dom.ls.LSSerializer.setFilter.

Set a LSSerilizerFilter on the LSSerializer. When set, the filter is called before each node is serialized which depending on its implemention determines if the node is to be serialized or not.

Parameters

filter:LSSerializerFilter: A LSSerializerFilter to be applied to the stream to serialize.

Since

DOM Level 3

See Also

org.w3c.dom.ls.LSSerializer#setFilter

setNewLine back to summary

setNewLine	back to summary
public void setNewLine(String newLine) Implements org.w3c.dom.ls.LSSerializer.setNewLine. Sets the End-Of-Line sequence of characters to be used in the XML being serialized. Setting this attribute to null will reset its value to the default value i.e. "\n". Parameters newLine:String a String that is the end-of-line character sequence to be used in serialization. Since DOM Level 3 See Also `org.w3c.dom.ls.LSSerializer#setNewLine`

public void setNewLine(String newLine)

Implements org.w3c.dom.ls.LSSerializer.setNewLine.

Sets the End-Of-Line sequence of characters to be used in the XML being serialized. Setting this attribute to null will reset its value to the default value i.e. "\n".

Parameters

newLine:String: a String that is the end-of-line character sequence to be used in serialization.

Since

DOM Level 3

setParameter back to summary

setParameter	back to summary
public void setParameter(String name, Object value) throws DOMException Implements org.w3c.dom.DOMConfiguration.setParameter. This method sets the value of the named parameter. Parameters name:String A String containing the DOMConfiguration parameter name. value:Object An Object contaiing the parameters value to set. Exceptions DOMException: Doc from org.w3c.dom.DOMConfiguration.setParameter. NOT_FOUND_ERR: Raised when the parameter name is not recognized. NOT_SUPPORTED_ERR: Raised when the parameter name is recognized but the requested value cannot be set. TYPE_MISMATCH_ERR: Raised if the value type for this parameter name is incompatible with the expected value type. See Also `org.w3c.dom.DOMConfiguration#setParameter(java.lang.String, java.lang.Object)`

public void setParameter(String name, Object value) throws DOMException

Implements org.w3c.dom.DOMConfiguration.setParameter.

This method sets the value of the named parameter.

Parameters

name:String: A String containing the DOMConfiguration parameter name.
value:Object: An Object contaiing the parameters value to set.

Exceptions

DOMException:

Doc from org.w3c.dom.DOMConfiguration.setParameter.

NOT_FOUND_ERR: Raised when the parameter name is not recognized.
NOT_SUPPORTED_ERR: Raised when the parameter name is recognized but the requested value cannot be set.
TYPE_MISMATCH_ERR: Raised if the value type for this parameter name is incompatible with the expected value type.

write back to summary

write	back to summary
public boolean write(Node nodeArg, LSOutput destination) throws LSException Implements org.w3c.dom.ls.LSSerializer.write. Serializes the specified node to the specified LSOutput and returns true if the Node was successfully serialized. Parameters nodeArg:Node The Node to serialize. destination:LSOutput Doc from org.w3c.dom.ls.LSSerializer.write. The destination for the serialized DOM. Returns:boolean Doc from org.w3c.dom.ls.LSSerializer.write. Returns `true` if `node` was successfully serialized. Return `false` in case the normal processing stopped but the implementation kept serializing the document; the result of the serialization being implementation dependent then. Exceptions LSException: SERIALIZE_ERR: Raised if the LSSerializer was unable to serialize the node. Since DOM Level 3 See Also `org.w3c.dom.ls.LSSerializer#write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)`

public boolean write(Node nodeArg, LSOutput destination) throws LSException

Implements org.w3c.dom.ls.LSSerializer.write.

Serializes the specified node to the specified LSOutput and returns true if the Node was successfully serialized.

Parameters

nodeArg:Node

The Node to serialize.

destination:LSOutput

Doc from org.w3c.dom.ls.LSSerializer.write.

The destination for the serialized DOM.

Returns:boolean

Doc from org.w3c.dom.ls.LSSerializer.write.

Returns true if node was successfully serialized. Return false in case the normal processing stopped but the implementation kept serializing the document; the result of the serialization being implementation dependent then.

Exceptions