Package 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 aReader
.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 bynext()
:- 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
Constructors Constructor 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
-
-
-
Constructor Detail
-
WrappedTextNodeStreamReader
public WrappedTextNodeStreamReader(QName wrapperElementName, Reader reader, int chunkSize)
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
-
-
Method Detail
-
getProperty
public Object getProperty(String name) throws IllegalArgumentException
- Specified by:
getProperty
in interfaceXMLStreamReader
- Throws:
IllegalArgumentException
-
hasNext
public boolean hasNext() throws XMLStreamException
- Specified by:
hasNext
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
next
public int next() throws XMLStreamException
- Specified by:
next
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
nextTag
public int nextTag() throws XMLStreamException
- 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
public void require(int type, String namespaceURI, String localName) throws XMLStreamException
- Specified by:
require
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getLocation
public Location getLocation()
- Specified by:
getLocation
in interfaceXMLStreamReader
-
close
public void close() throws XMLStreamException
- Specified by:
close
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getEncoding
public String getEncoding()
- Specified by:
getEncoding
in interfaceXMLStreamReader
-
getCharacterEncodingScheme
public String getCharacterEncodingScheme()
- Specified by:
getCharacterEncodingScheme
in interfaceXMLStreamReader
-
getVersion
public String 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
public NamespaceContext getNamespaceContext()
- Specified by:
getNamespaceContext
in interfaceXMLStreamReader
-
getNamespaceURI
public String getNamespaceURI(String prefix)
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getAttributeValue
public String getAttributeValue(String namespaceURI, String localName)
- Specified by:
getAttributeValue
in interfaceXMLStreamReader
-
getAttributeCount
public int getAttributeCount()
- Specified by:
getAttributeCount
in interfaceXMLStreamReader
-
getAttributeName
public QName getAttributeName(int index)
- Specified by:
getAttributeName
in interfaceXMLStreamReader
-
getAttributeLocalName
public String getAttributeLocalName(int index)
- Specified by:
getAttributeLocalName
in interfaceXMLStreamReader
-
getAttributePrefix
public String getAttributePrefix(int index)
- Specified by:
getAttributePrefix
in interfaceXMLStreamReader
-
getAttributeNamespace
public String getAttributeNamespace(int index)
- Specified by:
getAttributeNamespace
in interfaceXMLStreamReader
-
getAttributeType
public String getAttributeType(int index)
- Specified by:
getAttributeType
in interfaceXMLStreamReader
-
getAttributeValue
public String getAttributeValue(int index)
- Specified by:
getAttributeValue
in interfaceXMLStreamReader
-
isAttributeSpecified
public boolean isAttributeSpecified(int index)
- Specified by:
isAttributeSpecified
in interfaceXMLStreamReader
-
getName
public QName getName()
- Specified by:
getName
in interfaceXMLStreamReader
-
getLocalName
public String getLocalName()
- Specified by:
getLocalName
in interfaceXMLStreamReader
-
getPrefix
public String getPrefix()
- Specified by:
getPrefix
in interfaceXMLStreamReader
-
getNamespaceURI
public String getNamespaceURI()
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getNamespaceCount
public int getNamespaceCount()
- Specified by:
getNamespaceCount
in interfaceXMLStreamReader
-
getNamespacePrefix
public String getNamespacePrefix(int index)
- Specified by:
getNamespacePrefix
in interfaceXMLStreamReader
-
getNamespaceURI
public String getNamespaceURI(int index)
- Specified by:
getNamespaceURI
in interfaceXMLStreamReader
-
getElementText
public String getElementText() throws XMLStreamException
- Specified by:
getElementText
in interfaceXMLStreamReader
- Throws:
XMLStreamException
-
getText
public String 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
public String getPIData()
- Specified by:
getPIData
in interfaceXMLStreamReader
-
getPITarget
public String getPITarget()
- Specified by:
getPITarget
in interfaceXMLStreamReader
-
-