public class

DOMSerializerImpl

extends Object
implements DOMConfiguration LSSerializer
java.lang.Object
   ↳ org.apache.xml.serialize.DOMSerializerImpl

This class is deprecated.
Replaced by org.apache.xml.serializer.dom3.LSSerializerImpl in Xerces 2.9.0.

Class Overview

EXPERIMENTAL: Implemenatation of DOM Level 3 org.w3c.ls.LSSerializer by delegating serialization calls to XMLSerializer. LSSerializer provides an API for serializing (writing) a DOM document out in an XML document. The XML data is written to an output stream. During serialization of XML data, namespace fixup is done when possible as defined in DOM Level 3 Core, Appendix B.

Summary

Constants
short CDATA
short COMMENTS
short DISCARDDEFAULT
short DOM_ELEMENT_CONTENT_WHITESPACE
short ENTITIES
short INFOSET
short NAMESPACES
short NSDECL
short PRETTY_PRINT
short SPLITCDATA
short WELLFORMED
short XMLDECL
Fields
protected short features REVISIT: Currently we handle 3 different configurations, would be nice just have one configuration that has different recognized parameters depending if it is used in Core/LS.
Public Constructors
DOMSerializerImpl()
Constructs a new LSSerializer.
Public Methods
boolean canSetParameter(String name, Object state)
DOM L3-EXPERIMENTAL: Check if parameter can be set
DOMConfiguration getDomConfig()
LSSerializerFilter getFilter()
When the application provides a filter, the serializer will call out to the filter before serializing each Node.
String getNewLine()
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out.
Object getParameter(String name)
DOM L3-EXPERIMENTAL: Getter for boolean and object parameters
DOMStringList getParameterNames()
DOM Level 3 Core CR - Experimental.
void setFilter(LSSerializerFilter filter)
When the application provides a filter, the serializer will call out to the filter before serializing each Node.
void setNewLine(String newLine)
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out.
void setParameter(String name, Object value)
DOM L3-EXPERIMENTAL: Setter for boolean and object parameters
boolean write(Node node, LSOutput destination)
Serialize the specified node as described above in the general description of the LSSerializer interface.
String writeToString(Node wnode)
DOM L3 EXPERIMENTAL: Serialize the specified node as described above in the description of LSSerializer.
boolean writeToURI(Node node, String URI)
Serialize the specified node as described above in the general description of the LSSerializer interface.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.w3c.dom.DOMConfiguration
From interface org.w3c.dom.ls.LSSerializer

Constants

protected static final short CDATA

Constant Value: 8 (0x00000008)

protected static final short COMMENTS

Constant Value: 32 (0x00000020)

protected static final short DISCARDDEFAULT

Constant Value: 64 (0x00000040)

protected static final short DOM_ELEMENT_CONTENT_WHITESPACE

Constant Value: 1024 (0x00000400)

protected static final short ENTITIES

Constant Value: 4 (0x00000004)

protected static final short INFOSET

Constant Value: 128 (0x00000080)

protected static final short NAMESPACES

Constant Value: 1 (0x00000001)

protected static final short NSDECL

Constant Value: 512 (0x00000200)

protected static final short PRETTY_PRINT

Constant Value: 2048 (0x00000800)

protected static final short SPLITCDATA

Constant Value: 16 (0x00000010)

protected static final short WELLFORMED

Constant Value: 2 (0x00000002)

protected static final short XMLDECL

Constant Value: 256 (0x00000100)

Fields

protected short features

REVISIT: Currently we handle 3 different configurations, would be nice just have one configuration that has different recognized parameters depending if it is used in Core/LS.

Public Constructors

public DOMSerializerImpl ()

Constructs a new LSSerializer. The constructor turns on the namespace support in XMLSerializer and initializes the following fields: fNSBinder, fLocalNSBinder, fSymbolTable, fEmptySymbol, fXmlSymbol, fXmlnsSymbol, fNamespaceCounter, fFeatures.

Public Methods

public boolean canSetParameter (String name, Object state)

DOM L3-EXPERIMENTAL: Check if parameter can be set

public DOMConfiguration getDomConfig ()

public LSSerializerFilter getFilter ()

When the application provides a filter, the serializer will call out to the filter before serializing each Node. Attribute nodes are never passed to the filter. The filter implementation can choose to remove the node from the stream or to terminate the serialization early.

public String getNewLine ()

DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out. The only permitted values are these:

null
Use a default end-of-line sequence. DOM implementations should choose the default to match the usual convention for text files in the environment being used. Implementations must choose a default sequence that matches one of those allowed by 2.11 "End-of-Line Handling".
CR
The carriage-return character (#xD).
CR-LF
The carriage-return and line-feed characters (#xD #xA).
LF
The line-feed character (#xA).

The default value for this attribute is null.

public Object getParameter (String name)

DOM L3-EXPERIMENTAL: Getter for boolean and object parameters

Throws
DOMException

public DOMStringList getParameterNames ()

DOM Level 3 Core CR - Experimental. The list of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application. Note that this list can also contain parameter names defined outside this specification.

public void setFilter (LSSerializerFilter filter)

When the application provides a filter, the serializer will call out to the filter before serializing each Node. Attribute nodes are never passed to the filter. The filter implementation can choose to remove the node from the stream or to terminate the serialization early.

public void setNewLine (String newLine)

DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out. The only permitted values are these:

null
Use a default end-of-line sequence. DOM implementations should choose the default to match the usual convention for text files in the environment being used. Implementations must choose a default sequence that matches one of those allowed by 2.11 "End-of-Line Handling".
CR
The carriage-return character (#xD).
CR-LF
The carriage-return and line-feed characters (#xD #xA).
LF
The line-feed character (#xA).

The default value for this attribute is null.

public void setParameter (String name, Object value)

DOM L3-EXPERIMENTAL: Setter for boolean and object parameters

Throws
DOMException

public boolean write (Node node, LSOutput destination)

Serialize the specified node as described above in the general description of the LSSerializer interface. The output is written to the supplied LSOutput.
When writing to a LSOutput, the encoding is found by looking at the encoding information that is reachable through the LSOutput and the item to be written (or its owner document) in this order:

  1. LSOutput.encoding,
  2. Document.actualEncoding,
  3. Document.xmlEncoding.

If no encoding is reachable through the above properties, a default encoding of "UTF-8" will be used.
If the specified encoding is not supported an "unsupported-encoding" error is raised.
If no output is specified in the LSOutput, a "no-output-specified" error is raised.

Parameters
node The node to serialize.
destination The destination for the serialized DOM.
Returns
  • Returns true if node was successfully serialized and false in case the node couldn't be serialized.
Throws
LSException

public String writeToString (Node wnode)

DOM L3 EXPERIMENTAL: Serialize the specified node as described above in the description of LSSerializer. The result of serializing the node is returned as a string. Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.

Parameters
wnode The node to be written.
Returns
  • Returns the serialized data
Throws
DOMException DOMSTRING_SIZE_ERR: The resulting string is too long to fit in a DOMString.
LSException SERIALIZE_ERR: Unable to serialize the node. DOM applications should attach a DOMErrorHandler using the parameter "error-handler" to get details on error.

public boolean writeToURI (Node node, String URI)

Serialize the specified node as described above in the general description of the LSSerializer interface. The output is written to the supplied URI.
When writing to a URI, the encoding is found by looking at the encoding information that is reachable through the item to be written (or its owner document) in this order:

  1. Document.inputEncoding,
  2. Document.xmlEncoding.

If no encoding is reachable through the above properties, a default encoding of "UTF-8" will be used.
If the specified encoding is not supported an "unsupported-encoding" error is raised.

Parameters
node The node to serialize.
URI The URI to write to.
Returns
  • Returns true if node was successfully serialized and false in case the node couldn't be serialized.
Throws
LSException