org.apache.axiom.om.ds

Class OMDataSourceExtBase

java.lang.Object

org.apache.axiom.om.ds.OMDataSourceExtBase

All Implemented Interfaces:

OMDataSource, OMDataSourceExt

Direct Known Subclasses:

ByteArrayDataSource, CharArrayDataSource, InputStreamDataSource, ParserInputStreamDataSource, WrappedTextNodeOMDataSourceFromDataSource, WrappedTextNodeOMDataSourceFromReader

public abstract class OMDataSourceExtBase
extends Object
implements OMDataSourceExt

OMDataSourceExtBase is a convenient base class that can be extended by other OMDataSourceExt implementations.

Field Summary

Fields inherited from interface org.apache.axiom.om.OMDataSourceExt

LOSSY_PREFIX

Constructor Summary

Constructors

Constructor and Description
OMDataSourceExtBase()

Method Summary

Modifier and Type	Method and Description
Object	getProperty(String key) Query a property stored on the OMDataSource
InputStream	getXMLInputStream(String encoding) Returns a InputStream representing the xml data
boolean	hasProperty(String key) Returns true if property is set
void	serialize(OutputStream output, OMOutputFormat format) Serializes element data directly to stream.
void	serialize(Writer writer, OMOutputFormat format) Serializes element data directly to writer.
void	serialize(XMLStreamWriter xmlWriter) Serializes element data directly to StAX writer.
Object	setProperty(String key, Object value) Set a property on the OMDataSource

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.OMDataSourceExt

close, copy, getObject, getReader, getXMLBytes, isDestructiveRead, isDestructiveWrite

Constructor Detail

OMDataSourceExtBase

public OMDataSourceExtBase()

Method Detail

getProperty

public Object getProperty(String key)

Description copied from interface: OMDataSourceExt

Query a property stored on the OMDataSource

Specified by:

getProperty in interface OMDataSourceExt

Returns:

value or null

setProperty

public Object setProperty(String key,
                          Object value)

Description copied from interface: OMDataSourceExt

Set a property on the OMDataSource

Specified by:

setProperty in interface OMDataSourceExt

Returns:

old property object or null

hasProperty

public boolean hasProperty(String key)

Description copied from interface: OMDataSourceExt

Returns true if property is set

Specified by:

hasProperty in interface OMDataSourceExt

Returns:

TODO

getXMLInputStream

public InputStream getXMLInputStream(String encoding)
                              throws UnsupportedEncodingException

Description copied from interface: OMDataSourceExt

Returns a InputStream representing the xml data

Specified by:

getXMLInputStream in interface OMDataSourceExt

Parameters:

encoding - String encoding of InputStream

Returns:

InputStream

Throws:

UnsupportedEncodingException

serialize

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

Description copied from interface: OMDataSourceExt

Serializes element data directly to stream. Assumes that the backing object is destroyed during serialization if isDestructiveWrite

Specified by:

serialize in interface OMDataSource

Specified by:

serialize in interface OMDataSourceExt

Parameters:

output - destination stream for element XML text

format - Output format information. The implementation must use this information to choose the correct character set encoding when writing to the output stream. This parameter must not be null.

Throws:

XMLStreamException

See Also:

OMDataSourceExt

serialize

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

Description copied from interface: OMDataSourceExt

Serializes element data directly to writer. Assumes that the backing object is destroyed during serialization isDestructiveWrite

Specified by:

serialize in interface OMDataSource

Specified by:

serialize in interface OMDataSourceExt

Parameters:

writer - destination writer for element XML text

format - output format information (null if none; may be ignored if not supported by data binding even if supplied)

Throws:

XMLStreamException

See Also:

OMDataSourceExt

serialize

public void serialize(XMLStreamWriter xmlWriter)
               throws XMLStreamException

Description copied from interface: OMDataSourceExt

Serializes element data directly to StAX writer. Assumes that the backing object is destroyed during serialization isDestructiveWrite

Specified by:

serialize in interface OMDataSource

Specified by:

serialize in interface OMDataSourceExt

Parameters:

xmlWriter - destination writer

Throws:

XMLStreamException

See Also:

OMDataSourceExt