org.apache.axiom.util.stax

Class WrappedTextNodeStreamReader

java.lang.Object

org.apache.axiom.util.stax.WrappedTextNodeStreamReader

All Implemented Interfaces:

XMLStreamConstants, XMLStreamReader

public class WrappedTextNodeStreamReader
extends Object
implements XMLStreamReader

XMLStreamReader implementation that represents a text node wrapped inside an element. The text data is provided by a Reader.

It will produce the following sequence of XML events:

• START_DOCUMENT
• START_ELEMENT
• (CHARACTER)*
• END_ELEMENT
• END_DOCMENT

The class is implemented as a simple state machine, where the state is identified by the current event type. The initial state is START_DOCUMENT and the following transitions are triggered by next():

• START_DOCUMENT → START_ELEMENT
• START_ELEMENT → END_ELEMENT (if character stream is empty)
• START_ELEMENT → CHARACTERS (if character stream is not empty)
• CHARACTERS → CHARACTERS (if data available in stream)
• CHARACTERS → END_ELEMENT (if end of stream reached)
• END_ELEMENT → END_DOCUMENT

Additionally, getElementText() triggers the following transition:

• START_ELEMENT → END_ELEMENT

Note that since multiple consecutive CHARACTERS events may be returned, this "parser" is not coalescing.

Field Summary

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor and Description
WrappedTextNodeStreamReader(QName wrapperElementName, Reader reader) Create a new instance with chunk size 4096.
WrappedTextNodeStreamReader(QName wrapperElementName, Reader reader, int chunkSize) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	close()
int	getAttributeCount()
String	getAttributeLocalName(int index)
QName	getAttributeName(int index)
String	getAttributeNamespace(int index)
String	getAttributePrefix(int index)
String	getAttributeType(int index)
String	getAttributeValue(int index)
String	getAttributeValue(String namespaceURI, String localName)
String	getCharacterEncodingScheme()
String	getElementText()
String	getEncoding()
int	getEventType()
String	getLocalName()
Location	getLocation()
QName	getName()
NamespaceContext	getNamespaceContext()
int	getNamespaceCount()
String	getNamespacePrefix(int index)
String	getNamespaceURI()
String	getNamespaceURI(int index)
String	getNamespaceURI(String prefix)
String	getPIData()
String	getPITarget()
String	getPrefix()
Object	getProperty(String name)
String	getText()
char[]	getTextCharacters()
int	getTextCharacters(int sourceStart, char[] target, int targetStart, int length)
int	getTextLength()
int	getTextStart()
String	getVersion()
boolean	hasName()
boolean	hasNext()
boolean	hasText()
boolean	isAttributeSpecified(int index)
boolean	isCharacters()
boolean	isEndElement()
boolean	isStandalone()
boolean	isStartElement()
boolean	isWhiteSpace()
int	next()
int	nextTag()
void	require(int type, String namespaceURI, String localName)
boolean	standaloneSet()

Methods inherited from class java.lang.Object

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

Constructor Detail

WrappedTextNodeStreamReader

public WrappedTextNodeStreamReader(QName wrapperElementName,
                                   Reader reader,
                                   int chunkSize)

Create a new instance.

Parameters:

wrapperElementName - the qualified name of the wrapper element

reader - the Reader object holding the character data to be wrapped

chunkSize - the maximum number of characters that are returned for each CHARACTER event

WrappedTextNodeStreamReader

public WrappedTextNodeStreamReader(QName wrapperElementName,
                                   Reader reader)

Create a new instance with chunk size 4096.

Parameters:

wrapperElementName - the qualified name of the wrapper element

reader - the Reader object holding the character data to be wrapped

Method Detail

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Specified by:

getProperty in interface XMLStreamReader

Throws:

IllegalArgumentException

hasNext

public boolean hasNext()
                throws XMLStreamException

Specified by:

hasNext in interface XMLStreamReader

Throws:

XMLStreamException

next

public int next()
         throws XMLStreamException

Specified by:

next in interface XMLStreamReader

Throws:

XMLStreamException

nextTag

public int nextTag()
            throws XMLStreamException

Specified by:

nextTag in interface XMLStreamReader

Throws:

XMLStreamException

getEventType

public int getEventType()

Specified by:

getEventType in interface XMLStreamReader

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface XMLStreamReader

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface XMLStreamReader

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface XMLStreamReader

isWhiteSpace

public boolean isWhiteSpace()

Specified by:

isWhiteSpace in interface XMLStreamReader

hasText

public boolean hasText()

Specified by:

hasText in interface XMLStreamReader

hasName

public boolean hasName()

Specified by:

hasName in interface XMLStreamReader

require

public void require(int type,
                    String namespaceURI,
                    String localName)
             throws XMLStreamException

Specified by:

require in interface XMLStreamReader

Throws:

XMLStreamException

getLocation

public Location getLocation()

Specified by:

getLocation in interface XMLStreamReader

close

public void close()
           throws XMLStreamException

Specified by:

close in interface XMLStreamReader

Throws:

XMLStreamException

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface XMLStreamReader

getCharacterEncodingScheme

public String getCharacterEncodingScheme()

Specified by:

getCharacterEncodingScheme in interface XMLStreamReader

getVersion

public String getVersion()

Specified by:

getVersion in interface XMLStreamReader

standaloneSet

public boolean standaloneSet()

Specified by:

standaloneSet in interface XMLStreamReader

isStandalone

public boolean isStandalone()

Specified by:

isStandalone in interface XMLStreamReader

getNamespaceContext

public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI(String prefix)

Specified by:

getNamespaceURI in interface XMLStreamReader

getAttributeValue

public String getAttributeValue(String namespaceURI,
                                String localName)

Specified by:

getAttributeValue in interface XMLStreamReader

getAttributeCount

public int getAttributeCount()

Specified by:

getAttributeCount in interface XMLStreamReader

getAttributeName

public QName getAttributeName(int index)

Specified by:

getAttributeName in interface XMLStreamReader

getAttributeLocalName

public String getAttributeLocalName(int index)

Specified by:

getAttributeLocalName in interface XMLStreamReader

getAttributePrefix

public String getAttributePrefix(int index)

Specified by:

getAttributePrefix in interface XMLStreamReader

getAttributeNamespace

public String getAttributeNamespace(int index)

Specified by:

getAttributeNamespace in interface XMLStreamReader

getAttributeType

public String getAttributeType(int index)

Specified by:

getAttributeType in interface XMLStreamReader

getAttributeValue

public String getAttributeValue(int index)

Specified by:

getAttributeValue in interface XMLStreamReader

isAttributeSpecified

public boolean isAttributeSpecified(int index)

Specified by:

isAttributeSpecified in interface XMLStreamReader

getName

public QName getName()

Specified by:

getName in interface XMLStreamReader

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface XMLStreamReader

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface XMLStreamReader

getNamespaceCount

public int getNamespaceCount()

Specified by:

getNamespaceCount in interface XMLStreamReader

getNamespacePrefix

public String getNamespacePrefix(int index)

Specified by:

getNamespacePrefix in interface XMLStreamReader

getNamespaceURI

public String getNamespaceURI(int index)

Specified by:

getNamespaceURI in interface XMLStreamReader

getElementText

public String getElementText()
                      throws XMLStreamException

Specified by:

getElementText in interface XMLStreamReader

Throws:

XMLStreamException

getText

public String getText()

Specified by:

getText in interface XMLStreamReader

getTextCharacters

public char[] getTextCharacters()

Specified by:

getTextCharacters in interface XMLStreamReader

getTextStart

public int getTextStart()

Specified by:

getTextStart in interface XMLStreamReader

getTextLength

public int getTextLength()

Specified by:

getTextLength in interface XMLStreamReader

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int length)
                      throws XMLStreamException

Specified by:

getTextCharacters in interface XMLStreamReader

Throws:

XMLStreamException

getPIData

public String getPIData()

Specified by:

getPIData in interface XMLStreamReader

getPITarget

public String getPITarget()

Specified by:

getPITarget in interface XMLStreamReader