public interface XmlPullParser
Differences from StAX's XMLStreamReader are:
getName() and getAttributeName(int) return localname, there is getQName() and getAttributeQName(int) to retrieve the qualified name (QName).nextText() instead of XMLStreamReader.getElementText().
Differences from XPP3's XmlPullParser are:
getAttributeName(int) index return null instead of throwing an exception if no attribute with the given index exists.The following table shows the mapping of Smack's XmlPullParser events to StAX and XPP3 events:
Smack's XmlPullParser.Event | StAX Event | XPP3 Event |
|---|---|---|
XmlPullParser.Event.START_DOCUMENT | START_DOCUMENT (7) | START_DOCUMENT (0) |
XmlPullParser.Event.END_DOCUMENT | END_DOCUMENT (8) | END_DOCUMENT (1) |
XmlPullParser.Event.START_ELEMENT | START_ELEMENT (1) | START_TAG (2) |
XmlPullParser.Event.END_ELEMENT | END_ELEMENT (2) | END_TAG (3) |
XmlPullParser.Event.TEXT_CHARACTERS | CHARACTERS (4) | TEXT (4) |
XmlPullParser.Event.PROCESSING_INSTRUCTION | PROCESSING_INSTRUCTION (3) | PROCESSING_INSTRUCTION (8) |
XmlPullParser.Event.COMMENT | COMMENT (5) | COMMENT (9) |
XmlPullParser.Event.IGNORABLE_WHITESPACE | SPACE (6) | IGNORABLE_WHITESPACE (7) |
XmlPullParser.Event.ENTITY_REFERENCE | ENTITY_REFERENCE (9) | ENTITY_REF (6) |
XmlPullParser.Event.OTHER | ENTITY_REFERENCE (9) | ENTITY_REF (6) |
XmlPullParser.Event.OTHER includes
in case of StAX: ATTRIBUTE (10), DTD (11), CDATA (12), NAMESPACE (13), NOTATION_DECLARATION (14) and ENTITY_DECLRATION (15),
in case of XPP3: CDSECT (5), DOCDECL (10).
| Modifier and Type | Interface and Description |
|---|---|
static class |
XmlPullParser.Event |
static class |
XmlPullParser.TagEvent |
| Modifier and Type | Method and Description |
|---|---|
int |
getAttributeCount() |
java.lang.String |
getAttributeName(int index)
Returns the loacalpart of the attribute's name or
null in case the index does not refer to an
attribute. |
java.lang.String |
getAttributeNamespace(int index) |
java.lang.String |
getAttributePrefix(int index) |
javax.xml.namespace.QName |
getAttributeQName(int index) |
java.lang.String |
getAttributeType(int index) |
java.lang.String |
getAttributeValue(int index) |
default java.lang.String |
getAttributeValue(java.lang.String name) |
java.lang.String |
getAttributeValue(java.lang.String namespace,
java.lang.String name) |
int |
getColumnNumber() |
default java.lang.String |
getDefaultNamespace() |
int |
getDepth() |
XmlPullParser.Event |
getEventType() |
java.lang.String |
getInputEncoding() |
int |
getLineNumber() |
java.lang.String |
getName()
Return the name for the current START_ELEMENT or END_ELEMENT event.
|
java.lang.String |
getNamespace() |
java.lang.String |
getNamespace(java.lang.String prefix) |
int |
getNamespaceCount() |
java.lang.String |
getNamespacePrefix(int pos) |
java.lang.String |
getNamespaceUri(int pos) |
java.lang.String |
getPositionDescription() |
java.lang.String |
getPrefix() |
java.lang.Object |
getProperty(java.lang.String name) |
javax.xml.namespace.QName |
getQName() |
java.lang.String |
getText() |
boolean |
isWhiteSpace() |
XmlPullParser.Event |
next() |
XmlPullParser.TagEvent |
nextTag() |
java.lang.String |
nextText()
Reads the content of a text-only element, an exception is thrown if this is
not a text-only element.
|
boolean |
supportsRoundtrip() |
java.lang.Object getProperty(java.lang.String name)
java.lang.String getInputEncoding()
int getNamespaceCount()
throws XmlPullParserException
XmlPullParserExceptionjava.lang.String getNamespacePrefix(int pos)
throws XmlPullParserException
XmlPullParserExceptionjava.lang.String getNamespaceUri(int pos)
throws XmlPullParserException
XmlPullParserExceptionjava.lang.String getNamespace(java.lang.String prefix)
default java.lang.String getDefaultNamespace()
int getDepth()
java.lang.String getPositionDescription()
int getLineNumber()
int getColumnNumber()
boolean isWhiteSpace()
throws XmlPullParserException
XmlPullParserExceptionjava.lang.String getText()
java.lang.String getNamespace()
java.lang.String getName()
javax.xml.namespace.QName getQName()
java.lang.String getPrefix()
int getAttributeCount()
java.lang.String getAttributeNamespace(int index)
java.lang.String getAttributeName(int index)
null in case the index does not refer to an
attribute.index - the attribute index.null.javax.xml.namespace.QName getAttributeQName(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 namespace,
java.lang.String name)
default java.lang.String getAttributeValue(java.lang.String name)
XmlPullParser.Event getEventType() throws XmlPullParserException
XmlPullParserExceptionXmlPullParser.Event next() throws java.io.IOException, XmlPullParserException
java.io.IOExceptionXmlPullParserExceptionjava.lang.String nextText()
throws java.io.IOException,
XmlPullParserException
java.io.IOException - in case of an IO error.XmlPullParserException - in case of an XML pull parser error.XmlPullParser.TagEvent nextTag() throws java.io.IOException, XmlPullParserException
java.io.IOExceptionXmlPullParserExceptionboolean supportsRoundtrip()