public abstract class AbstractXMLStreamReader<T>
extends java.lang.Object
implements javax.xml.stream.XMLStreamReader
Constructor and Description |
---|
AbstractXMLStreamReader(T rootInfo)
Create new reader instance.
|
AbstractXMLStreamReader(T rootInfo,
javax.xml.stream.Location locationProvider)
Create new reader instance.
|
Modifier and Type | Method and Description |
---|---|
void |
close() |
protected abstract boolean |
consume()
Main method to be implemented by subclasses.
|
int |
getAttributeCount() |
java.lang.String |
getAttributeLocalName(int index) |
javax.xml.namespace.QName |
getAttributeName(int index) |
java.lang.String |
getAttributeNamespace(int index) |
java.lang.String |
getAttributePrefix(int index) |
java.lang.String |
getAttributeType(int index) |
java.lang.String |
getAttributeValue(int index) |
java.lang.String |
getAttributeValue(java.lang.String namespaceURI,
java.lang.String localName) |
java.lang.String |
getCharacterEncodingScheme() |
java.lang.String |
getElementText() |
java.lang.String |
getEncoding() |
protected java.lang.Object |
getEventData() |
protected java.lang.String |
getEventName() |
int |
getEventType() |
java.lang.String |
getLocalName() |
javax.xml.stream.Location |
getLocation() |
javax.xml.namespace.QName |
getName() |
javax.xml.namespace.NamespaceContext |
getNamespaceContext() |
int |
getNamespaceCount() |
java.lang.String |
getNamespacePrefix(int index) |
java.lang.String |
getNamespaceURI() |
java.lang.String |
getNamespaceURI(int index) |
java.lang.String |
getNamespaceURI(java.lang.String prefix) |
java.lang.String |
getPIData() |
java.lang.String |
getPITarget() |
java.lang.String |
getPrefix() |
java.lang.Object |
getProperty(java.lang.String name) |
protected XMLStreamReaderScope<T> |
getScope() |
java.lang.String |
getText() |
char[] |
getTextCharacters() |
int |
getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int length) |
int |
getTextLength() |
int |
getTextStart() |
java.lang.String |
getVersion() |
boolean |
hasName() |
boolean |
hasNext() |
boolean |
hasText() |
protected void |
initialize()
Consume initial event.
|
boolean |
isAttributeSpecified(int index) |
boolean |
isCharacters() |
boolean |
isEndElement() |
boolean |
isStandalone() |
protected boolean |
isStartDocumentRead() |
boolean |
isStartElement() |
boolean |
isWhiteSpace() |
int |
next() |
int |
nextTag() |
protected void |
readAttr(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI,
java.lang.String value)
Read attribute.
|
protected void |
readData(java.lang.String text,
java.lang.Object data,
int type)
Read characters/comment/dtd/entity data.
|
protected void |
readEndDocument()
Read end document.
|
protected void |
readEndElementTag()
Read end element.
|
protected void |
readNsDecl(java.lang.String prefix,
java.lang.String namespaceURI)
Read namespace declaration.
|
protected void |
readPI(java.lang.String target,
java.lang.String data)
Read processing instruction.
|
protected void |
readStartDocument(java.lang.String version,
java.lang.String encodingScheme,
java.lang.Boolean standalone)
Read start document
|
protected void |
readStartElementTag(java.lang.String prefix,
java.lang.String localName,
java.lang.String namespaceURI,
T scopeInfo)
Read start element.
|
void |
require(int eventType,
java.lang.String namespaceURI,
java.lang.String localName) |
boolean |
standaloneSet() |
java.lang.String |
toString() |
public AbstractXMLStreamReader(T rootInfo)
rootInfo
- root scope informationpublic AbstractXMLStreamReader(T rootInfo, javax.xml.stream.Location locationProvider)
rootInfo
- root scope informationprotected XMLStreamReaderScope<T> getScope()
protected boolean isStartDocumentRead()
true
if START_DOCUMENT
event has been readprotected void initialize() throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
protected abstract boolean consume() throws javax.xml.stream.XMLStreamException, java.io.IOException
readXXX()
methods.
When encountering an element start event, all attributes and namespace delarations
must be consumed too, otherwise these won't be available during start element.true
if there's more to readjavax.xml.stream.XMLStreamException
java.io.IOException
protected void readStartDocument(java.lang.String version, java.lang.String encodingScheme, java.lang.Boolean standalone) throws javax.xml.stream.XMLStreamException
version
- XML versionencodingScheme
- encoding scheme (may be null
)standalone
- standalone flag (may be null
)javax.xml.stream.XMLStreamException
protected void readStartElementTag(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI, T scopeInfo) throws javax.xml.stream.XMLStreamException
scopeInfo
is
stored in the new scope and will be available via getScope().getInfo()
.prefix
- element prefix (use null
if unknown)localName
- local namenamespaceURI
- (use null
if unknown)scopeInfo
- new scope infojavax.xml.stream.XMLStreamException
protected void readAttr(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI, java.lang.String value) throws javax.xml.stream.XMLStreamException
prefix
- attribute prefix (use null
if unknown)localName
- local namenamespaceURI
- (use null
if unknown)value
- attribute valuejavax.xml.stream.XMLStreamException
protected void readNsDecl(java.lang.String prefix, java.lang.String namespaceURI) throws javax.xml.stream.XMLStreamException
prefix
- namespace prefix (must not be null
)namespaceURI
- namespace URI (must not be null
)javax.xml.stream.XMLStreamException
protected void readData(java.lang.String text, java.lang.Object data, int type) throws javax.xml.stream.XMLStreamException
text
- textdata
- additional data exposed by getEventData()
(e.g. type conversion)type
- one of CHARACTERS, COMMENT, CDATA, DTD, ENTITY_REFERENCE, SPACE
javax.xml.stream.XMLStreamException
protected void readPI(java.lang.String target, java.lang.String data) throws javax.xml.stream.XMLStreamException
target
- PI targetdata
- PI data (may be null
)javax.xml.stream.XMLStreamException
protected void readEndElementTag() throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
protected void readEndDocument() throws javax.xml.stream.XMLStreamException
javax.xml.stream.XMLStreamException
public void require(int eventType, java.lang.String namespaceURI, java.lang.String localName) throws javax.xml.stream.XMLStreamException
require
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public java.lang.String getElementText() throws javax.xml.stream.XMLStreamException
getElementText
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public boolean hasNext() throws javax.xml.stream.XMLStreamException
hasNext
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public int next() throws javax.xml.stream.XMLStreamException
next
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public int nextTag() throws javax.xml.stream.XMLStreamException
nextTag
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public void close() throws javax.xml.stream.XMLStreamException
close
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public boolean isStartElement()
isStartElement
in interface javax.xml.stream.XMLStreamReader
public boolean isEndElement()
isEndElement
in interface javax.xml.stream.XMLStreamReader
public boolean isCharacters()
isCharacters
in interface javax.xml.stream.XMLStreamReader
public boolean isWhiteSpace()
isWhiteSpace
in interface javax.xml.stream.XMLStreamReader
public int getAttributeCount()
getAttributeCount
in interface javax.xml.stream.XMLStreamReader
public javax.xml.namespace.QName getAttributeName(int index)
getAttributeName
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributeLocalName(int index)
getAttributeLocalName
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributeValue(int index)
getAttributeValue
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributePrefix(int index)
getAttributePrefix
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributeNamespace(int index)
getAttributeNamespace
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributeType(int index)
getAttributeType
in interface javax.xml.stream.XMLStreamReader
public boolean isAttributeSpecified(int index)
isAttributeSpecified
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getAttributeValue(java.lang.String namespaceURI, java.lang.String localName)
getAttributeValue
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getNamespaceURI(java.lang.String prefix)
getNamespaceURI
in interface javax.xml.stream.XMLStreamReader
public int getNamespaceCount()
getNamespaceCount
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getNamespacePrefix(int index)
getNamespacePrefix
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getNamespaceURI(int index)
getNamespaceURI
in interface javax.xml.stream.XMLStreamReader
public javax.xml.namespace.NamespaceContext getNamespaceContext()
getNamespaceContext
in interface javax.xml.stream.XMLStreamReader
public int getEventType()
getEventType
in interface javax.xml.stream.XMLStreamReader
protected java.lang.String getEventName()
protected final java.lang.Object getEventData()
public javax.xml.stream.Location getLocation()
getLocation
in interface javax.xml.stream.XMLStreamReader
public boolean hasText()
hasText
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getText()
getText
in interface javax.xml.stream.XMLStreamReader
public char[] getTextCharacters()
getTextCharacters
in interface javax.xml.stream.XMLStreamReader
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws javax.xml.stream.XMLStreamException
getTextCharacters
in interface javax.xml.stream.XMLStreamReader
javax.xml.stream.XMLStreamException
public int getTextStart()
getTextStart
in interface javax.xml.stream.XMLStreamReader
public int getTextLength()
getTextLength
in interface javax.xml.stream.XMLStreamReader
public boolean hasName()
hasName
in interface javax.xml.stream.XMLStreamReader
public javax.xml.namespace.QName getName()
getName
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getLocalName()
getLocalName
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getNamespaceURI()
getNamespaceURI
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getPrefix()
getPrefix
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getVersion()
getVersion
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getEncoding()
getEncoding
in interface javax.xml.stream.XMLStreamReader
public boolean isStandalone()
isStandalone
in interface javax.xml.stream.XMLStreamReader
public boolean standaloneSet()
standaloneSet
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getCharacterEncodingScheme()
getCharacterEncodingScheme
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getPITarget()
getPITarget
in interface javax.xml.stream.XMLStreamReader
public java.lang.String getPIData()
getPIData
in interface javax.xml.stream.XMLStreamReader
public java.lang.Object getProperty(java.lang.String name) throws java.lang.IllegalArgumentException
getProperty
in interface javax.xml.stream.XMLStreamReader
java.lang.IllegalArgumentException
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2005-2022 Apache Software Foundation. All Rights Reserved.