org.apache.axiom.om.ds
Class WrappedTextNodeOMDataSourceFromReader

java.lang.Object
  extended by org.apache.axiom.om.ds.OMDataSourceExtBase
      extended by org.apache.axiom.om.ds.WrappedTextNodeOMDataSourceFromReader
All Implemented Interfaces:
OMDataSource, OMDataSourceExt

public class WrappedTextNodeOMDataSourceFromReader
extends OMDataSourceExtBase

OMDataSource implementation that represents a text node wrapped inside an element. The text data is provided by a Reader object. Since the stream can only be read once, this data source is destructive.


Field Summary
 
Fields inherited from interface org.apache.axiom.om.OMDataSourceExt
LOSSY_PREFIX
 
Constructor Summary
WrappedTextNodeOMDataSourceFromReader(QName wrapperElementName, Reader reader)
           
 
Method Summary
 void close()
          Close the DataSource and free its resources.
 OMDataSourceExt copy()
          Create a copy of the OMDataSourceExt
 Object getObject()
          Returns the backing Object.
 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.
 void serialize(Writer writer, OMOutputFormat format)
          Serializes element data directly to writer.
 void serialize(XMLStreamWriter xmlWriter)
          Serializes element data directly to StAX writer.
 
Methods inherited from class org.apache.axiom.om.ds.OMDataSourceExtBase
getProperty, getXMLInputStream, hasProperty, serialize, setProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WrappedTextNodeOMDataSourceFromReader

public WrappedTextNodeOMDataSourceFromReader(QName wrapperElementName,
                                             Reader reader)
Method Detail

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
Overrides:
serialize in class OMDataSourceExtBase
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
Overrides:
serialize in class OMDataSourceExtBase
Parameters:
xmlWriter - destination writer
Throws:
XMLStreamException
See Also:
OMDataSourceExt

getReader

public XMLStreamReader getReader()
                          throws XMLStreamException
Description copied from interface: OMDataSourceExt
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:
XMLStreamException

getObject

public 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(String encoding)
                   throws UnsupportedEncodingException
Description copied from interface: OMDataSourceExt
Returns a byte[] representing the xml data

Parameters:
encoding - String encoding of InputStream
Returns:
byte[]
Throws:
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


Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.