Package org.jivesoftware.smack.xml.stax

Class StaxXmlPullParser

java.lang.Object

org.jivesoftware.smack.xml.stax.StaxXmlPullParser

All Implemented Interfaces:

XmlPullParser

public final class StaxXmlPullParser
extends Object
implements XmlPullParser

Nested Class Summary

Nested classes/interfaces inherited from interface org.jivesoftware.smack.xml.XmlPullParser

XmlPullParser.Event, XmlPullParser.TagEvent

Method Summary

Modifier and Type	Method	Description
int	getAttributeCount()
String	getAttributeName(int index)	Returns the loacalpart of the attribute's name or null in case the index does not refer to an attribute.
String	getAttributeNamespace(int index)
String	getAttributePrefix(int index)
QName	getAttributeQName(int index)
String	getAttributeType(int index)
String	getAttributeValue(int index)
String	getAttributeValue(String namespace, String name)
int	getColumnNumber()
int	getDepth()
XmlPullParser.Event	getEventType()
String	getInputEncoding()
int	getLineNumber()
String	getName()	Return the name for the current START_ELEMENT or END_ELEMENT event.
String	getNamespace()
String	getNamespace(String prefix)
int	getNamespaceCount()
String	getNamespacePrefix(int pos)
String	getNamespaceUri(int pos)
String	getPositionDescription()
String	getPrefix()
Object	getProperty(String name)
QName	getQName()
String	getText()
boolean	isWhiteSpace()
XmlPullParser.Event	next()
XmlPullParser.TagEvent	nextTag()
String	nextText()	Reads the content of a text-only element, an exception is thrown if this is not a text-only element.
boolean	supportsRoundtrip()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.xml.XmlPullParser

getAttributeValue, getDefaultNamespace

Method Detail

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface XmlPullParser

getInputEncoding

public String getInputEncoding()

Specified by:

getInputEncoding in interface XmlPullParser

getNamespaceCount

public int getNamespaceCount()

Specified by:

getNamespaceCount in interface XmlPullParser

getNamespacePrefix

public String getNamespacePrefix(int pos)

Specified by:

getNamespacePrefix in interface XmlPullParser

getNamespaceUri

public String getNamespaceUri(int pos)

Specified by:

getNamespaceUri in interface XmlPullParser

getNamespace

public String getNamespace(String prefix)

Specified by:

getNamespace in interface XmlPullParser

getDepth

public int getDepth()

Specified by:

getDepth in interface XmlPullParser

getPositionDescription

public String getPositionDescription()

Specified by:

getPositionDescription in interface XmlPullParser

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface XmlPullParser

getColumnNumber

public int getColumnNumber()

Specified by:

getColumnNumber in interface XmlPullParser

isWhiteSpace

public boolean isWhiteSpace()

Specified by:

isWhiteSpace in interface XmlPullParser

getText

public String getText()

Specified by:

getText in interface XmlPullParser

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface XmlPullParser

getName

public String getName()

Description copied from interface: XmlPullParser

Return the name for the current START_ELEMENT or END_ELEMENT event. This method must only be called if the current event is START_ELEMENT or END_ELEMENT.

Specified by:

getName in interface XmlPullParser

Returns:

the name for the current START_ELEMETN or END_ELEMENT event.

getQName

public QName getQName()

Specified by:

getQName in interface XmlPullParser

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface XmlPullParser

getAttributeCount

public int getAttributeCount()

Specified by:

getAttributeCount in interface XmlPullParser

getAttributeNamespace

public String getAttributeNamespace(int index)

Specified by:

getAttributeNamespace in interface XmlPullParser

getAttributeName

public String getAttributeName(int index)

Description copied from interface: XmlPullParser

Returns the loacalpart of the attribute's name or null in case the index does not refer to an attribute.

Specified by:

getAttributeName in interface XmlPullParser

Parameters:

index - the attribute index.

Returns:

the localpart of the attribute's name or null.

getAttributeQName

public QName getAttributeQName(int index)

Specified by:

getAttributeQName in interface XmlPullParser

getAttributePrefix

public String getAttributePrefix(int index)

Specified by:

getAttributePrefix in interface XmlPullParser

getAttributeType

public String getAttributeType(int index)

Specified by:

getAttributeType in interface XmlPullParser

getAttributeValue

public String getAttributeValue(int index)

Specified by:

getAttributeValue in interface XmlPullParser

getAttributeValue

public String getAttributeValue(String namespace,
                                String name)

Specified by:

getAttributeValue in interface XmlPullParser

getEventType

public XmlPullParser.Event getEventType()

Specified by:

getEventType in interface XmlPullParser

next

public XmlPullParser.Event next()
                         throws XmlPullParserException

Specified by:

next in interface XmlPullParser

Throws:

XmlPullParserException

nextText

public String nextText()
                throws IOException,
                       XmlPullParserException

Description copied from interface: XmlPullParser

Reads the content of a text-only element, an exception is thrown if this is not a text-only element.

• Precondition: the current event is START_ELEMENT.
• Postcondition: the current event is the corresponding END_ELEMENT.

Specified by:

nextText in interface XmlPullParser

Returns:

the textual content of the current element.

Throws:

IOException - in case of an IO error.

XmlPullParserException - in case of an XML pull parser error.

nextTag

public XmlPullParser.TagEvent nextTag()
                               throws IOException,
                                      XmlPullParserException

Specified by:

nextTag in interface XmlPullParser

Throws:

IOException

XmlPullParserException

supportsRoundtrip

public boolean supportsRoundtrip()

Specified by:

supportsRoundtrip in interface XmlPullParser