org.xmlpull.v1.wrapper.classic

Class StaticXmlPullParserWrapper

java.lang.Object

org.xmlpull.v1.wrapper.classic.XmlPullParserDelegate

org.xmlpull.v1.wrapper.classic.StaticXmlPullParserWrapper

All Implemented Interfaces:

XmlPullParserWrapper, XmlPullParser

public class StaticXmlPullParserWrapper
extends XmlPullParserDelegate
implements XmlPullParserWrapper

This class seemlesly extends exisiting parser implementation by adding new methods (provided by XmlPullUtil) and delegating exisiting methods to parser implementation.

Author:

Aleksander Slominski, Naresh Bhatia

Field Summary

Fields inherited from class org.xmlpull.v1.wrapper.classic.XmlPullParserDelegate

pp

Fields inherited from interface org.xmlpull.v1.wrapper.XmlPullParserWrapper

XSD_NS, XSI_NS

Fields inherited from interface org.xmlpull.v1.XmlPullParser

CDSECT, COMMENT, DOCDECL, END_DOCUMENT, END_TAG, ENTITY_REF, FEATURE_PROCESS_DOCDECL, FEATURE_PROCESS_NAMESPACES, FEATURE_REPORT_NAMESPACE_ATTRIBUTES, FEATURE_VALIDATION, IGNORABLE_WHITESPACE, NO_NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_TAG, TEXT, TYPES

Constructor Summary

Constructors

Constructor and Description
StaticXmlPullParserWrapper(XmlPullParser pp)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttributeValue(String name) Return value of attribute with given name and no namespace.
String	getPIData() Return everything past PITarget and S from Processing Instruction (PI) as defined in XML 1.0 Section 2.6 Processing Instructions [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
String	getPITarget() Return PITarget from Processing Instruction (PI) as defined in XML 1.0 Section 2.6 Processing Instructions [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
String	getRequiredAttributeValue(String name) Read attribute value and return it or throw exception if current element does not have such attribute.
String	getRequiredAttributeValue(String namespace, String name) Read attribute value and return it or throw exception if current element does not have such attribute.
String	getRequiredElementText(String namespace, String name) Read the text of a required element and return it or throw exception if required element is not found.
boolean	isNil() Is the current tag nil? Checks for xsi:nil="true".
boolean	matches(int type, String namespace, String name) Tests if the current event is of the given type and if the namespace and name match.
void	nextEndTag() Call parser nextTag() and check that it is END_TAG, throw exception if not.
void	nextEndTag(String name) combine nextTag(); pp.require(XmlPullParser.END_TAG, null, name);
void	nextEndTag(String namespace, String name) combine nextTag(); pp.require(XmlPullParser.END_TAG, namespace, name);
void	nextStartTag() call parser nextTag() and check that it is START_TAG, throw exception if not.
void	nextStartTag(String name) combine nextTag(); pp.require(XmlPullParser.START_TAG, null, name);
void	nextStartTag(String namespace, String name) combine nextTag(); pp.require(XmlPullParser.START_TAG, namespace, name);
String	nextText(String namespace, String name) Read text content of element ith given namespace and name (use null namespace do indicate that nemspace should not be checked)
double	readDouble()
double	readDoubleElement(String namespace, String name)
float	readFloat()
float	readFloatElement(String namespace, String name)
int	readInt()
int	readIntElement(String namespace, String name)
String	readString()
String	readStringElemet(String namespace, String name)
void	skipSubTree() Skip sub tree that is currently porser positioned on.

Methods inherited from class org.xmlpull.v1.wrapper.classic.XmlPullParserDelegate

defineEntityReplacementText, getAttributeCount, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getColumnNumber, getDepth, getEventType, getFeature, getInputEncoding, getLineNumber, getName, getNamespace, getNamespace, getNamespaceCount, getNamespacePrefix, getNamespaceUri, getPositionDescription, getPrefix, getProperty, getText, getTextCharacters, isAttributeDefault, isEmptyElementTag, isWhitespace, next, nextTag, nextText, nextToken, require, setFeature, setInput, setInput, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xmlpull.v1.XmlPullParser

defineEntityReplacementText, getAttributeCount, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getColumnNumber, getDepth, getEventType, getFeature, getInputEncoding, getLineNumber, getName, getNamespace, getNamespace, getNamespaceCount, getNamespacePrefix, getNamespaceUri, getPositionDescription, getPrefix, getProperty, getText, getTextCharacters, isAttributeDefault, isEmptyElementTag, isWhitespace, next, nextTag, nextText, nextToken, require, setFeature, setInput, setInput, setProperty

Constructor Detail

StaticXmlPullParserWrapper

public StaticXmlPullParserWrapper(XmlPullParser pp)

Method Detail

getAttributeValue

public String getAttributeValue(String name)

Description copied from interface: XmlPullParserWrapper

Return value of attribute with given name and no namespace.

Specified by:

getAttributeValue in interface XmlPullParserWrapper

getRequiredAttributeValue

public String getRequiredAttributeValue(String name)
                                 throws IOException,
                                        XmlPullParserException

Description copied from interface: XmlPullParserWrapper

Read attribute value and return it or throw exception if current element does not have such attribute.

Specified by:

getRequiredAttributeValue in interface XmlPullParserWrapper

Throws:

IOException

XmlPullParserException

getRequiredAttributeValue

public String getRequiredAttributeValue(String namespace,
                               String name)
                                 throws IOException,
                                        XmlPullParserException

Description copied from interface: XmlPullParserWrapper

Read attribute value and return it or throw exception if current element does not have such attribute.

Specified by:

getRequiredAttributeValue in interface XmlPullParserWrapper

Throws:

IOException

XmlPullParserException

getRequiredElementText

public String getRequiredElementText(String namespace,
                            String name)
                              throws IOException,
                                     XmlPullParserException

Read the text of a required element and return it or throw exception if required element is not found. Useful for getting the text of simple elements such as johndoe. Assumes that parser is just before the start tag and leaves the parser at the end tag. If the text is nil (e.g. ), then a null will be returned.

Specified by:

getRequiredElementText in interface XmlPullParserWrapper

Throws:

IOException

XmlPullParserException

isNil

public boolean isNil()
              throws IOException,
                     XmlPullParserException

Description copied from interface: XmlPullParserWrapper

Is the current tag nil? Checks for xsi:nil="true".

Specified by:

isNil in interface XmlPullParserWrapper

Throws:

IOException

XmlPullParserException

getPITarget

public String getPITarget()
                   throws IllegalStateException

Description copied from interface: XmlPullParserWrapper

Return PITarget from Processing Instruction (PI) as defined in XML 1.0 Section 2.6 Processing Instructions [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'

Specified by:

getPITarget in interface XmlPullParserWrapper

Throws:

IllegalStateException

getPIData

public String getPIData()
                 throws IllegalStateException

Description copied from interface: XmlPullParserWrapper

Return everything past PITarget and S from Processing Instruction (PI) as defined in XML 1.0 Section 2.6 Processing Instructions [16] PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'

NOTE: if there is no PI data it returns empty string.

Specified by:

getPIData in interface XmlPullParserWrapper

Throws:

IllegalStateException

matches

public boolean matches(int type,
              String namespace,
              String name)
                throws XmlPullParserException

Description copied from interface: XmlPullParserWrapper

Tests if the current event is of the given type and if the namespace and name match. null will match any namespace and any name. If the test passes a true is returned otherwise a false is returned.

Specified by:

matches in interface XmlPullParserWrapper

Throws:

XmlPullParserException

nextStartTag

public void nextStartTag()
                  throws XmlPullParserException,
                         IOException

Description copied from interface: XmlPullParserWrapper

call parser nextTag() and check that it is START_TAG, throw exception if not.

Specified by:

nextStartTag in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

nextStartTag

public void nextStartTag(String name)
                  throws XmlPullParserException,
                         IOException

Description copied from interface: XmlPullParserWrapper

combine nextTag(); pp.require(XmlPullParser.START_TAG, null, name);

Specified by:

nextStartTag in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

nextStartTag

public void nextStartTag(String namespace,
                String name)
                  throws XmlPullParserException,
                         IOException

Description copied from interface: XmlPullParserWrapper

combine nextTag(); pp.require(XmlPullParser.START_TAG, namespace, name);

Specified by:

nextStartTag in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

nextEndTag

public void nextEndTag()
                throws XmlPullParserException,
                       IOException

Description copied from interface: XmlPullParserWrapper

Call parser nextTag() and check that it is END_TAG, throw exception if not.

Specified by:

nextEndTag in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

nextEndTag

public void nextEndTag(String name)
                throws XmlPullParserException,
                       IOException

Description copied from interface: XmlPullParserWrapper

combine nextTag(); pp.require(XmlPullParser.END_TAG, null, name);

Specified by:

nextEndTag in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

nextEndTag

public void nextEndTag(String namespace,
              String name)
                throws XmlPullParserException,
                       IOException

Description copied from interface: XmlPullParserWrapper

combine nextTag(); pp.require(XmlPullParser.END_TAG, namespace, name);

Specified by:

nextEndTag in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

nextText

public String nextText(String namespace,
              String name)
                throws IOException,
                       XmlPullParserException

Description copied from interface: XmlPullParserWrapper

Read text content of element ith given namespace and name (use null namespace do indicate that nemspace should not be checked)

Specified by:

nextText in interface XmlPullParserWrapper

Throws:

IOException

XmlPullParserException

skipSubTree

public void skipSubTree()
                 throws XmlPullParserException,
                        IOException

Description copied from interface: XmlPullParserWrapper

Skip sub tree that is currently porser positioned on.
NOTE: parser must be on START_TAG and when funtion returns parser will be positioned on matching END_TAG This is typically optimized internally by parser but the logic should follow this: pp.require(XmlPullParser.START_TAG, null, null); int level = 1; while(level > 0) { int eventType = pp.next(); if(eventType == XmlPullParser.END_TAG) { --level; } else if(eventType == XmlPullParser.START_TAG) { ++level; } }

Specified by:

skipSubTree in interface XmlPullParserWrapper

Throws:

XmlPullParserException

IOException

readDouble

public double readDouble()
                  throws XmlPullParserException,
                         IOException

Throws:

XmlPullParserException

IOException

readFloat

public float readFloat()
                throws XmlPullParserException,
                       IOException

Throws:

XmlPullParserException

IOException

readInt

public int readInt()
            throws XmlPullParserException,
                   IOException

Throws:

XmlPullParserException

IOException

readString

public String readString()
                  throws XmlPullParserException,
                         IOException

Throws:

XmlPullParserException

IOException

readDoubleElement

public double readDoubleElement(String namespace,
                       String name)
                         throws XmlPullParserException,
                                IOException

Throws:

XmlPullParserException

IOException

readFloatElement

public float readFloatElement(String namespace,
                     String name)
                       throws XmlPullParserException,
                              IOException

Throws:

XmlPullParserException

IOException

readIntElement

public int readIntElement(String namespace,
                 String name)
                   throws XmlPullParserException,
                          IOException

Throws:

XmlPullParserException

IOException

readStringElemet

public String readStringElemet(String namespace,
                      String name)
                        throws XmlPullParserException,
                               IOException

Throws:

XmlPullParserException

IOException