org.apache.xml.serializer.dom3

Class LSSerializerImpl

public final class LSSerializerImpl extends Object implements DOMConfiguration, LSSerializer

Implemenatation of DOM Level 3 org.w3c.ls.LSSerializer and org.w3c.dom.ls.DOMConfiguration. Serialization is achieved by delegating serialization calls to org.apache.xml.serializer.ToStream or one of its derived classes depending on the serialization method, while walking the DOM in DOM3TreeWalker.

Version: $Id:

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

UNKNOWN: internal

Constructor Summary
LSSerializerImpl()
Constructor: Creates a LSSerializerImpl object.
Method Summary
booleancanSetParameter(String name, Object value)
Checks if setting a parameter to a specific value is supported.
DOMConfigurationgetDomConfig()
Returns the DOMConfiguration of the LSSerializer.
DOMErrorHandlergetErrorHandler()
This method returns the LSSerializer's error handler.
LSSerializerFiltergetFilter()
Returns the DOMConfiguration of the LSSerializer.
StringgetNewLine()
Returns the End-Of-Line sequence of characters to be used in the XML being serialized.
ObjectgetParameter(String name)
This method returns the value of a parameter if known.
DOMStringListgetParameterNames()
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
voidinitializeSerializerProps()
Initializes the underlying serializer's configuration depending on the default DOMConfiguration parameters.
voidsetFilter(LSSerializerFilter filter)
Set a LSSerilizerFilter on the LSSerializer.
voidsetNewLine(String newLine)
Sets the End-Of-Line sequence of characters to be used in the XML being serialized.
voidsetParameter(String name, Object value)
This method sets the value of the named parameter.
booleanwrite(Node nodeArg, LSOutput destination)
Serializes the specified node to the specified LSOutput and returns true if the Node was successfully serialized.
StringwriteToString(Node nodeArg)
Serializes the specified node and returns a String with the serialized data to the caller.
booleanwriteToURI(Node nodeArg, String uri)
Serializes the specified node to the specified URI and returns true if the Node was successfully serialized.

Constructor Detail

LSSerializerImpl

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

public boolean canSetParameter(String name, Object value)
Checks if setting a parameter to a specific value is supported.

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

Since: DOM Level 3

See Also: org.w3c.dom.DOMConfiguration#canSetParameter(java.lang.String, java.lang.Object)

getDomConfig

public DOMConfiguration getDomConfig()
Returns the DOMConfiguration of the LSSerializer.

Returns: A DOMConfiguration object.

Since: DOM Level 3

See Also: org.w3c.dom.ls.LSSerializer#getDomConfig()

getErrorHandler

public DOMErrorHandler getErrorHandler()
This method returns the LSSerializer's error handler.

Returns: Returns the fDOMErrorHandler.

getFilter

public LSSerializerFilter getFilter()
Returns the DOMConfiguration of the LSSerializer.

Returns: A LSSerializerFilter object.

Since: DOM Level 3

See Also: org.w3c.dom.ls.LSSerializer#getFilter()

getNewLine

public String 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: 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

public Object getParameter(String name)
This method returns the value of a parameter if known.

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

Returns: Object The value of the parameter if known.

See Also: org.w3c.dom.DOMConfiguration#getParameter(java.lang.String)

getParameterNames

public DOMStringList 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 A list of DOMConfiguration parameters recognized by the serializer

See Also: org.w3c.dom.DOMConfiguration#getParameterNames()

initializeSerializerProps

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.

UNKNOWN: internal

setFilter

public void setFilter(LSSerializerFilter filter)
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 A LSSerializerFilter to be applied to the stream to serialize.

Since: DOM Level 3

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

setNewLine

public void setNewLine(String newLine)
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 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

setParameter

public void setParameter(String name, Object value)
This method sets the value of the named parameter.

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

See Also: org.w3c.dom.DOMConfiguration#setParameter(java.lang.String, java.lang.Object)

write

public boolean write(Node nodeArg, LSOutput destination)
Serializes the specified node to the specified LSOutput and returns true if the Node was successfully serialized.

Parameters: nodeArg The Node to serialize.

Throws: org.w3c.dom.ls.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)

writeToString

public String writeToString(Node nodeArg)
Serializes the specified node and returns a String with the serialized data to the caller.

Parameters: nodeArg The Node to serialize.

Throws: org.w3c.dom.ls.LSException SERIALIZE_ERR: Raised if the LSSerializer was unable to serialize the node.

Since: DOM Level 3

See Also: org.w3c.dom.ls.LSSerializer#writeToString(org.w3c.dom.Node)

writeToURI

public boolean writeToURI(Node nodeArg, String uri)
Serializes the specified node to the specified URI and returns true if the Node was successfully serialized.

Parameters: nodeArg The Node to serialize.

Throws: org.w3c.dom.ls.LSException SERIALIZE_ERR: Raised if the LSSerializer was unable to serialize the node.

Since: DOM Level 3

See Also: org.w3c.dom.ls.LSSerializer#writeToURI(org.w3c.dom.Node, String)

Copyright B) 2006 Apache XML Project. All Rights Reserved.