javax.xml.stream
public interface XMLStreamReader extends XMLStreamConstants
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT
Modifier and Type | Method and Description |
---|---|
void |
close()
Frees any resources used by this parser.
|
int |
getAttributeCount()
Returns the number of attributes on this element.
|
String |
getAttributeLocalName(int index)
Returns the local-name of the attribute at the given index.
|
QName |
getAttributeName(int index)
Returns the QName of the attribute at the given index.
|
String |
getAttributeNamespace(int index)
Returns the namespace URI of the attribute at the given index.
|
String |
getAttributePrefix(int index)
Returns the namespace prefix of the attribute at the given index.
|
String |
getAttributeType(int index)
Returns the type of the attribute at the specified index.
|
String |
getAttributeValue(int index)
Returns the normalized value of the attribute at the given index.
|
String |
getAttributeValue(String namespaceURI,
String localName)
Returns the normalized attribute value for the given attribute.
|
String |
getCharacterEncodingScheme()
Returns the encoding declared in the XML declaration.
|
String |
getElementText()
Returns the text content of a text-only element.
|
String |
getEncoding()
Returns the input encoding.
|
int |
getEventType()
Returns the type of the current event.
|
String |
getLocalName()
Returns the local-name of the current element.
|
Location |
getLocation()
Returns the current location of the parser cursor in the underlying
input source.
|
QName |
getName()
Returns the QName of the current element.
|
NamespaceContext |
getNamespaceContext()
Returns the namespace context for the current position.
|
int |
getNamespaceCount()
Returns the number of namespaces declared on this event.
|
String |
getNamespacePrefix(int index)
Returns the prefix of the namespace at the given index, or null if this
is the default namespace declaration.
|
String |
getNamespaceURI()
Returns the namespace URI of the current element.
|
String |
getNamespaceURI(int index)
Returns the URI of the namespace at the given index.
|
String |
getNamespaceURI(String prefix)
Returns the namespace URI for the given prefix.
|
String |
getPIData()
Returns the data of the current processing instruction event.
|
String |
getPITarget()
Returns the target of the current processing instruction event.
|
String |
getPrefix()
Returns the namespace prefix of the current element.
|
Object |
getProperty(String name)
Returns the implementation-specific feature or property of the given
name.
|
String |
getText()
Returns the string value of the current event.
|
char[] |
getTextCharacters()
Returns the string value of the current event as a character array.
|
int |
getTextCharacters(int sourceStart,
char[] target,
int targetStart,
int length)
Copies the string value of the current event into the specified
character array.
|
int |
getTextLength()
Returns the length of the characters in the text character array.
|
int |
getTextStart()
Returns the offset of the first character in the text character array.
|
String |
getVersion()
Returns the XML version declared in the XML declaration.
|
boolean |
hasName()
Indicates whether the current event has a name.
|
boolean |
hasNext()
Indicates whether there are any remaining events to be read.
|
boolean |
hasText()
Indicates whether the current event has text.
|
boolean |
isAttributeSpecified(int index)
Indicates whether the attribute at the given index was specified in the
underlying XML source or created by default.
|
boolean |
isCharacters()
Indicates whether the current event is character data.
|
boolean |
isEndElement()
Indicates whether the current event is END_ELEMENT.
|
boolean |
isStandalone()
Returns the standalone flag declared in the XML declaration.
|
boolean |
isStartElement()
Indicates whether the current event is START_ELEMENT.
|
boolean |
isWhiteSpace()
Indicates whether the current event is ignorable whitespace.
|
int |
next()
Returns the next parsing event.
|
int |
nextTag()
Skips any ignorable whitespace, comments, and processing instructions
until a START_ELEMENT or END_ELEMENT event is encountered.
|
void |
require(int type,
String namespaceURI,
String localName)
Tests whether the current event is of the given type and namespace.
|
boolean |
standaloneSet()
Indicates whether the standalone flag was set in the document.
|
Object getProperty(String name) throws IllegalArgumentException
IllegalArgumentException
int next() throws XMLStreamException
XMLStreamException
void require(int type, String namespaceURI, String localName) throws XMLStreamException
XMLStreamException
- if the test failsString getElementText() throws XMLStreamException
XMLStreamException
int nextTag() throws XMLStreamException
XMLStreamException
- if an event of any other type is
encounteredboolean hasNext() throws XMLStreamException
XMLStreamException
void close() throws XMLStreamException
XMLStreamException
String getNamespaceURI(String prefix)
boolean isStartElement()
boolean isEndElement()
boolean isCharacters()
boolean isWhiteSpace()
String getAttributeValue(String namespaceURI, String localName)
int getAttributeCount()
QName getAttributeName(int index)
String getAttributeNamespace(int index)
String getAttributeLocalName(int index)
String getAttributePrefix(int index)
String getAttributeType(int index)
String getAttributeValue(int index)
boolean isAttributeSpecified(int index)
int getNamespaceCount()
String getNamespacePrefix(int index)
String getNamespaceURI(int index)
NamespaceContext getNamespaceContext()
int getEventType()
char[] getTextCharacters()
int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException
XMLStreamException
int getTextStart()
int getTextLength()
String getEncoding()
boolean hasText()
Location getLocation()
QName getName()
String getLocalName()
boolean hasName()
String getNamespaceURI()
String getVersion()
boolean isStandalone()
boolean standaloneSet()
String getCharacterEncodingScheme()
String getPITarget()