org.apache.axiom.om.impl.llom

Class OMSerializableImpl

java.lang.Object

org.apache.axiom.om.impl.llom.OMSerializableImpl

All Implemented Interfaces:

OMInformationItem, OMSerializable

Direct Known Subclasses:

OMDocumentImpl, OMNodeImpl

public abstract class OMSerializableImpl
extends Object
implements OMSerializable

Field Summary

Fields

Modifier and Type	Field and Description
protected OMFactory	factory

Constructor Summary

Constructors

Constructor and Description
OMSerializableImpl(OMFactory factory)

Method Summary

Modifier and Type	Method and Description
void	close(boolean build) If a builder and parser is associated with the node, it is closed.
abstract OMXMLParserWrapper	getBuilder()
OMFactory	getOMFactory() Get the OMFactory that created this information item.
abstract void	internalSerialize(XMLStreamWriter writer, boolean cache) Serializes the node.
void	serialize(OutputStream output)
void	serialize(OutputStream output, OMOutputFormat format)
void	serialize(Writer writer)
void	serialize(Writer writer2, OMOutputFormat format)
void	serialize(XMLStreamWriter xmlWriter) Serializes the information item with caching.
void	serialize(XMLStreamWriter xmlWriter, boolean cache) Serializes the information item to the given XMLStreamWriter.
void	serializeAndConsume(OutputStream output)
void	serializeAndConsume(OutputStream output, OMOutputFormat format)
void	serializeAndConsume(Writer writer)
void	serializeAndConsume(Writer writer2, OMOutputFormat format)
void	serializeAndConsume(XMLStreamWriter xmlWriter) Serializes the information item without caching.
abstract void	setComplete(boolean state)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, isComplete

Methods inherited from interface org.apache.axiom.om.OMInformationItem

clone

Field Detail

factory

protected OMFactory factory

Constructor Detail

OMSerializableImpl

public OMSerializableImpl(OMFactory factory)

Method Detail

getOMFactory

public OMFactory getOMFactory()

Description copied from interface: OMInformationItem

Get the OMFactory that created this information item.

Specified by:

getOMFactory in interface OMInformationItem

getBuilder

public abstract OMXMLParserWrapper getBuilder()

close

public void close(boolean build)

Description copied from interface: OMSerializable

If a builder and parser is associated with the node, it is closed.

Specified by:

close in interface OMSerializable

Parameters:

build - if true, the object is built first before closing the builder/parser

setComplete

public abstract void setComplete(boolean state)

internalSerialize

public abstract void internalSerialize(XMLStreamWriter writer,
                                       boolean cache)
                                throws XMLStreamException

Serializes the node.

Parameters:

writer -

Throws:

XMLStreamException

serialize

public void serialize(XMLStreamWriter xmlWriter)
               throws XMLStreamException

Description copied from interface: OMSerializable

Serializes the information item with caching. This method has the same effect as OMSerializable.serialize(XMLStreamWriter, boolean) with cache set to true.

Specified by:

serialize in interface OMSerializable

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(XMLStreamWriter xmlWriter)
                         throws XMLStreamException

Description copied from interface: OMSerializable

Serializes the information item without caching. This method has the same effect as OMSerializable.serialize(XMLStreamWriter, boolean) with cache set to false.

Specified by:

serializeAndConsume in interface OMSerializable

Throws:

XMLStreamException

serialize

public void serialize(XMLStreamWriter xmlWriter,
                      boolean cache)
               throws XMLStreamException

Description copied from interface: OMSerializable

Serializes the information item to the given XMLStreamWriter.

The implementation of this method must satisfy the following requirements:

• If the writer exposes the DataHandlerWriter extension, then base64 binary data MUST be written using one of the methods defined by that extension. This will occur if the information item is an OMText node for which OMText.isBinary() returns true or if it is an OMContainer that has such an OMText node as descendant. If the writer doesn't expose the DataHandlerWriter extension, then the implementation MUST use XMLStreamWriter.writeCharacters(String) or XMLStreamWriter.writeCharacters(char[], int, int) to write the base64 encoded data to the stream.
• The implementation MUST ensure that the produced XML is well formed with respect to namespaces, i.e. it MUST generate the required namespace declarations using XMLStreamWriter.writeNamespace(String, String) and XMLStreamWriter.writeDefaultNamespace(String). This requirement is always applicable, even if the method is used to serialize a subtree or if the object model is not well formed with respect to namespaces. This means that the implementation is expected to implement namespace repairing and that the implementation MUST NOT assume that the XMLStreamWriter supplied by the caller performs any kind of namespace repairing.
• The implementation MUST take into account the pre-existing namespace context, so that the caller can use this method to serialize the information item as part of a larger document. The implementation uses XMLStreamWriter.getPrefix(String) and/or XMLStreamWriter.getNamespaceContext() to query the pre-existing namespace context.

On the other hand, the caller of this method must ensure that the following requirements are satisfied:

• The namespace context information provided by XMLStreamWriter.getPrefix(String) and XMLStreamWriter.getNamespaceContext() MUST accurately reflect the actual namespace context at the location in the output document where the information item is serialized. In practice this requirement means that if the caller writes content to the XMLStreamWriter before calling this method, then it must use XMLStreamWriter.setPrefix(String, String) and XMLStreamWriter.setDefaultNamespace(String) to update the namespace context. Note that this requirement may be relaxed if the caller implements some form of namespace repairing.

Specified by:

serialize in interface OMSerializable

cache - indicates if caching should be enabled

Throws:

XMLStreamException

serialize

public void serialize(OutputStream output)
               throws XMLStreamException

Throws:

XMLStreamException

serialize

public void serialize(Writer writer)
               throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(OutputStream output)
                         throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(Writer writer)
                         throws XMLStreamException

Throws:

XMLStreamException

serialize

public void serialize(OutputStream output,
                      OMOutputFormat format)
               throws XMLStreamException

Throws:

XMLStreamException

serialize

public void serialize(Writer writer2,
                      OMOutputFormat format)
               throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(OutputStream output,
                                OMOutputFormat format)
                         throws XMLStreamException

Throws:

XMLStreamException

serializeAndConsume

public void serializeAndConsume(Writer writer2,
                                OMOutputFormat format)
                         throws XMLStreamException

Throws:

XMLStreamException