org.apache.axiom.om.ds
Class ByteArrayDataSource

java.lang.Object
  org.apache.axiom.om.ds.OMDataSourceExtBase
      org.apache.axiom.om.ds.ByteArrayDataSource

All Implemented Interfaces:

OMDataSource, OMDataSourceExt

public class ByteArrayDataSource
extends OMDataSourceExtBase

ByteArrayDataSource is an example implementation of OMDataSourceExt. Use it to insert a (byte[], encoding) into an OM Tree. This data source is useful for placing bytes into an OM tree, instead of having a deeply nested tree.

Nested Class Summary

class

ByteArrayDataSource.ByteArray Object containing the byte[]/encoding pair

Field Summary

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

LOSSY_PREFIX

Constructor Summary

ByteArrayDataSource(byte[] bytes, java.lang.String encoding)
Constructor

Method Summary

void	close() Close the DataSource and free its resources.
OMDataSourceExt	copy() Create a copy of the OMDataSourceExt
java.lang.Object	getObject() Returns the backing Object.
javax.xml.stream.XMLStreamReader	getReader() Get parser for element data.
byte[]	getXMLBytes(java.lang.String encoding) Returns a byte[] representing the xml data
boolean	isDestructiveRead() Returns true if reading the backing object is destructive.
boolean	isDestructiveWrite() Returns true if writing the backing object is destructive.

Methods inherited from class org.apache.axiom.om.ds.OMDataSourceExtBase

getProperty, getXMLInputStream, hasProperty, serialize, serialize, serialize, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArrayDataSource

public ByteArrayDataSource(byte[] bytes,
                           java.lang.String encoding)

Constructor

Parameters:

bytes -

encoding -

Method Detail

getReader

public javax.xml.stream.XMLStreamReader getReader()
                                           throws javax.xml.stream.XMLStreamException

Description copied from interface: OMDataSource

Get parser for element data. In the general case this may require the data source to serialize data as XML text and then parse that text.

Returns:

element parser

Throws:

javax.xml.stream.XMLStreamException

getObject

public java.lang.Object getObject()

Description copied from interface: OMDataSourceExt

Returns the backing Object.

Returns:

Object

isDestructiveRead

public boolean isDestructiveRead()

Description copied from interface: OMDataSourceExt

Returns true if reading the backing object is destructive. An example of an object with a destructive read is an InputSteam. The owning OMSourcedElement uses this information to detemine if OM tree expansion is needed when reading the OMDataSourceExt.

Returns:

boolean

isDestructiveWrite

public boolean isDestructiveWrite()

Description copied from interface: OMDataSourceExt

Returns true if writing the backing object is destructive. An example of an object with a destructive write is an InputStream. The owning OMSourcedElement uses this information to detemine if OM tree expansion is needed when writing the OMDataSourceExt.

Returns:

boolean

getXMLBytes

public byte[] getXMLBytes(java.lang.String encoding)
                   throws java.io.UnsupportedEncodingException

Description copied from interface: OMDataSourceExt

Returns a byte[] representing the xml data

Parameters:

encoding - String encoding of InputStream

Returns:

byte[]

Throws:

java.io.UnsupportedEncodingException

See Also:

OMDataSourceExt.getXMLInputStream(String)

close

public void close()

Description copied from interface: OMDataSourceExt

Close the DataSource and free its resources.

copy

public OMDataSourceExt copy()

Description copied from interface: OMDataSourceExt

Create a copy of the OMDataSourceExt

Returns:

OMDataSourceExt