APIdia Launch Partner
Top Description Methods
com.sun.org.apache.xml.internal.serializer

public Interface DOM3Serializer

Known Direct Implementers
com.sun.org.apache.xml.internal.serializer.dom3.DOM3SerializerImpl
Imports
java.io.IOException, org.w3c.dom.Node, .DOMErrorHandler, org.w3c.dom.ls.LSSerializerFilter

Interface for a DOM serializer capable of serializing DOMs as specified in the DOM Level 3 Save Recommendation.

The DOM3Serializer is a facet of a serializer and is obtained from the asDOM3Serializer() method of the org.apache.xml.serializer.Serializer interface. A serializer may or may not support a level 3 DOM serializer, if it does not then the return value from asDOM3Serializer() is null.

Example:

Document     doc;
Serializer   ser;
OutputStream os;
DOMErrorHandler handler;

ser = ...;
os = ...;
handler = ...;

ser.setOutputStream( os );
DOM3Serialzier dser = (DOM3Serialzier)ser.asDOM3Serializer();
dser.setErrorHandler(handler);
dser.serialize(doc);
See Also
org.apache.xml.serializer.Serializer

Method Summary

Modifier and TypeMethod and Description
public DOMErrorHandler

Returns:

A Level 3 DOMErrorHandler
getErrorHandler
()

Returns a DOMErrorHandler set on the DOM Level 3 Serializer.

public LSSerializerFilter

Returns:

The Level 3 LSSerializerFilter
getNodeFilter
()

Returns a LSSerializerFilter set on the DOM Level 3 Serializer to filter nodes during serialization.

public void
serializeDOM3(Node
the Level 3 DOM node to serialize
node
)

Serializes the Level 3 DOM node.

public void
setErrorHandler(DOMErrorHandler
the Level 3 DOMErrorHandler
handler
)

Sets a DOMErrorHandler on the DOM Level 3 Serializer.

public void
setNewLine(String
a String that is the end-of-line character sequence to be used in serialization.
newLine
)

Sets the new line character to be used during serialization

public void
setNodeFilter(LSSerializerFilter
the Level 3 LSSerializerFilter
filter
)

Sets a LSSerializerFilter on the DOM Level 3 Serializer to filter nodes during serialization.

Method Detail

getErrorHandlerback to summary
public DOMErrorHandler getErrorHandler()

Returns a DOMErrorHandler set on the DOM Level 3 Serializer. This interface is a public API.

Returns:DOMErrorHandler

A Level 3 DOMErrorHandler

getNodeFilterback to summary
public LSSerializerFilter getNodeFilter()

Returns a LSSerializerFilter set on the DOM Level 3 Serializer to filter nodes during serialization. This interface is a public API.

Returns:LSSerializerFilter

The Level 3 LSSerializerFilter

serializeDOM3back to summary
public void serializeDOM3(Node node) throws IOException

Serializes the Level 3 DOM node. Throws an exception only if an I/O exception occured while serializing. This interface is a public API.

Parameters
node:Node

the Level 3 DOM node to serialize

Exceptions
IOException:
if an I/O exception occured while serializing
setErrorHandlerback to summary
public void setErrorHandler(DOMErrorHandler handler)

Sets a DOMErrorHandler on the DOM Level 3 Serializer. This interface is a public API.

Parameters
handler:DOMErrorHandler

the Level 3 DOMErrorHandler

setNewLineback to summary
public void setNewLine(String newLine)

Sets the new line character to be used during serialization

Parameters
newLine:String

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

setNodeFilterback to summary
public void setNodeFilter(LSSerializerFilter filter)

Sets a LSSerializerFilter on the DOM Level 3 Serializer to filter nodes during serialization. This interface is a public API.

Parameters
filter:LSSerializerFilter

the Level 3 LSSerializerFilter