Package org.apache.axiom.util.stax
Class WrappedTextNodeStreamReader
java.lang.Object
org.apache.axiom.util.stax.WrappedTextNodeStreamReader
- All Implemented Interfaces:
XMLStreamConstants
,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
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
getElementText()
triggers the following transition:
- START_ELEMENT → END_ELEMENT
-
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
ConstructorsConstructorDescriptionWrappedTextNodeStreamReader
(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 TypeMethodDescriptionvoid
close()
int
getAttributeLocalName
(int index) getAttributeName
(int index) getAttributeNamespace
(int index) getAttributePrefix
(int index) getAttributeType
(int index) getAttributeValue
(int index) getAttributeValue
(String namespaceURI, String localName) int
getName()
int
getNamespacePrefix
(int index) getNamespaceURI
(int index) getNamespaceURI
(String prefix) getProperty
(String name) getText()
char[]
int
getTextCharacters
(int sourceStart, char[] target, int targetStart, int length) int
int
boolean
hasName()
boolean
hasNext()
boolean
hasText()
boolean
isAttributeSpecified
(int index) boolean
boolean
boolean
boolean
boolean
int
next()
int
nextTag()
void
boolean
-
Constructor Details
-
WrappedTextNodeStreamReader
Create a new instance.- Parameters:
wrapperElementName
- the qualified name of the wrapper elementreader
- the Reader object holding the character data to be wrappedchunkSize
- the maximum number of characters that are returned for each CHARACTER event
-
WrappedTextNodeStreamReader
Create a new instance with chunk size 4096.- Parameters:
wrapperElementName
- the qualified name of the wrapper elementreader
- the Reader object holding the character data to be wrapped
-
-
Method Details
-
getProperty
- Specified by:
getProperty
in interfaceXMLStreamReader
- Throws:
IllegalArgumentException
-
hasNext
- Specified by:
hasNext
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
next
- Specified by:
next
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
nextTag
- Specified by:
nextTag
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getEventType
public int getEventType()- Specified by:
getEventType
in interfaceXMLStreamReader
-
isStartElement
public boolean isStartElement()- Specified by:
isStartElement
in interfaceXMLStreamReader
-
isEndElement
public boolean isEndElement()- Specified by:
isEndElement
in interfaceXMLStreamReader
-
isCharacters
public boolean isCharacters()- Specified by:
isCharacters
in interfaceXMLStreamReader
-
isWhiteSpace
public boolean isWhiteSpace()- Specified by:
isWhiteSpace
in interfaceXMLStreamReader
-
hasText
public boolean hasText()- Specified by:
hasText
in interfaceXMLStreamReader
-
hasName
public boolean hasName()- Specified by:
hasName
in interfaceXMLStreamReader
-
require
- Specified by:
require
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getLocation
- Specified by:
getLocation
in interfaceXMLStreamReader
-
close
- Specified by:
close
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getEncoding
- Specified by:
getEncoding
in interfaceXMLStreamReader
-
getCharacterEncodingScheme
- Specified by:
getCharacterEncodingScheme
in interfaceXMLStreamReader
-
getVersion
- Specified by:
getVersion
in interfaceXMLStreamReader
-
standaloneSet
public boolean standaloneSet()- Specified by:
standaloneSet
in interfaceXMLStreamReader
-
isStandalone
public boolean isStandalone()- Specified by:
isStandalone
in interfaceXMLStreamReader
-
getNamespaceContext
- Specified by:
getNamespaceContext
in interfaceXMLStreamReader
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getAttributeValue
- Specified by:
getAttributeValue
in interfaceXMLStreamReader
-
getAttributeCount
public int getAttributeCount()- Specified by:
getAttributeCount
in interfaceXMLStreamReader
-
getAttributeName
- Specified by:
getAttributeName
in interfaceXMLStreamReader
-
getAttributeLocalName
- Specified by:
getAttributeLocalName
in interfaceXMLStreamReader
-
getAttributePrefix
- Specified by:
getAttributePrefix
in interfaceXMLStreamReader
-
getAttributeNamespace
- Specified by:
getAttributeNamespace
in interfaceXMLStreamReader
-
getAttributeType
- Specified by:
getAttributeType
in interfaceXMLStreamReader
-
getAttributeValue
- Specified by:
getAttributeValue
in interfaceXMLStreamReader
-
isAttributeSpecified
public boolean isAttributeSpecified(int index) - Specified by:
isAttributeSpecified
in interfaceXMLStreamReader
-
getName
- Specified by:
getName
in interfaceXMLStreamReader
-
getLocalName
- Specified by:
getLocalName
in interfaceXMLStreamReader
-
getPrefix
- Specified by:
getPrefix
in interfaceXMLStreamReader
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getNamespaceCount
public int getNamespaceCount()- Specified by:
getNamespaceCount
in interfaceXMLStreamReader
-
getNamespacePrefix
- Specified by:
getNamespacePrefix
in interfaceXMLStreamReader
-
getNamespaceURI
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getElementText
- Specified by:
getElementText
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getText
- Specified by:
getText
in interfaceXMLStreamReader
-
getTextCharacters
public char[] getTextCharacters()- Specified by:
getTextCharacters
in interfaceXMLStreamReader
-
getTextStart
public int getTextStart()- Specified by:
getTextStart
in interfaceXMLStreamReader
-
getTextLength
public int getTextLength()- Specified by:
getTextLength
in interfaceXMLStreamReader
-
getTextCharacters
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException - Specified by:
getTextCharacters
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getPIData
- Specified by:
getPIData
in interfaceXMLStreamReader
-
getPITarget
- Specified by:
getPITarget
in interfaceXMLStreamReader
-