org.apache.axiom.util.stax

Class TextFromElementReader

java.lang.Object

java.io.Reader

org.apache.axiom.util.stax.TextFromElementReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

class TextFromElementReader
extends java.io.Reader

Reader implementation that extracts the text nodes from an element given by an XMLStreamReader. The expected input is a document with only a document element (as produced by OMContainer.getXMLStreamReader()). The class will extract the text nodes that are direct children of that element, i.e. it uses the same conventions as OMElement.getText(). It will call XMLStreamReader.close() when the end of the document is reached or when close() is called.

The main purpose of this class is to provide a convenient and efficient way to get the text content of an element without converting it first to a string, i.e. without using OMElement.getText(). This is important for potentially large contents, for which this class guarantees constant memory usage.

Note that this class should in general not be used directly. Instead, org.apache.axiom.om.util.ElementHelper#getTextAsStream(org.apache.axiom.om.OMElement) should be called to get the most efficient stream implementation for a given an element.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowNonTextChildren
private boolean	endOfStream Flag indicating that we have reached the end of the document and that the underlying parser has been closed.
private int	skipDepth The current depth relative to the document element (not the document).
private int	sourceStart The current position in the character data of the event, or -1 if all the character data has been consumed and a new event needs to be requested from the parser.
private javax.xml.stream.XMLStreamReader	stream

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
TextFromElementReader(javax.xml.stream.XMLStreamReader stream, boolean allowNonTextChildren)

Method Summary

Modifier and Type	Method and Description
void	close()
int	read(char[] cbuf, int off, int len)

Methods inherited from class java.io.Reader

mark, markSupported, read, read, read, ready, reset, skip

Methods inherited from class java.lang.Object

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

Field Detail

stream

private final javax.xml.stream.XMLStreamReader stream

allowNonTextChildren

private final boolean allowNonTextChildren

endOfStream

private boolean endOfStream

Flag indicating that we have reached the end of the document and that the underlying parser has been closed.

skipDepth

private int skipDepth

The current depth relative to the document element (not the document). A value greater than 0 indicates that we are inside a nested element and that we need to skip text nodes.

sourceStart

private int sourceStart

The current position in the character data of the event, or -1 if all the character data has been consumed and a new event needs to be requested from the parser.

Constructor Detail

TextFromElementReader

TextFromElementReader(javax.xml.stream.XMLStreamReader stream,
                      boolean allowNonTextChildren)

Method Detail

read

public int read(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException

Specified by:

read in class java.io.Reader

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Reader

Throws:

java.io.IOException