|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axiom.om.ds.OMDataSourceExtBase
org.apache.axiom.om.ds.ByteArrayDataSource
public class ByteArrayDataSource
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,
String encoding)
Constructor |
Method Summary | |
---|---|
void |
close()
Close the DataSource and free its resources. |
OMDataSourceExt |
copy()
Create a copy of the data source. |
Object |
getObject()
Get the object that backs this data source. |
XMLStreamReader |
getReader()
Get parser for element data. |
byte[] |
getXMLBytes(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 |
---|
public ByteArrayDataSource(byte[] bytes, String encoding)
bytes
- encoding
- Method Detail |
---|
public XMLStreamReader getReader() throws XMLStreamException
OMDataSource
It is assumed that this method consumed the content (i.e. destroys the backing object) unless
the data source also implements OMDataSourceExt
and
OMDataSourceExt.isDestructiveRead()
returns false
.
XMLStreamException
public Object getObject()
OMDataSourceExt
OMSourcedElement.getObject(Class)
instead.
Data sources that support non destructive read/write should return the object from which the XML is produced. Data sources with destructive read/write should return a non null value only if the backing object has not been consumed yet (even partially).
null
if the data source has no backing object or
if the backing object can't be accessed in a safe waypublic boolean isDestructiveRead()
OMDataSourceExt
public boolean isDestructiveWrite()
OMDataSourceExt
public byte[] getXMLBytes(String encoding) throws UnsupportedEncodingException
OMDataSourceExt
encoding
- String encoding of InputStream
UnsupportedEncodingException
OMDataSourceExt.getXMLInputStream(String)
public void close()
OMDataSourceExt
public OMDataSourceExt copy()
OMDataSourceExt
OMInformationItem.clone(OMCloneOptions)
when the
OMCloneOptions.isCopyOMDataSources()
option is enabled. If the data source is
immutable and stateless, then it may return a reference to itself instead of creating a new
data source instance.
null
if the data source can't be copied
(e.g. because it is destructive)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |