org.gjt.xpp

Interface XmlPullParser

public interface XmlPullParser

Generic interface for simple and quick XML Pull Parser.
Author:
Aleksander Slominski
See Also:
XmlPullParserFactory

Field Summary

static byte
CONTENT
element content was just read
static byte
END_DOCUMENT
signal logical end of xml document
static byte
END_TAG
end tag was just read
static byte
START_TAG
start tag was just read

Method Summary

int
getColumnNumber()
int
getContentLength()
Return how big is content.
int
getDepth()
Returns the current depth of the element.
byte
getEventType()
Returns the type of the current element (START_TAG, END_TAG, CONTENT, etc)
int
getLineNumber()
String
getLocalName()
Returns the local name of the current element (current event must be START_TAG or END_TAG)
String
getNamespaceUri()
Returns the namespace URI of the current element Returns null if not applicable (current event must be START_TAG or END_TAG)
int
getNamespacesLength(int depth)
String
getPosDesc()
String
getPrefix()
Returns the prefix of the current element or null if elemet has no prefix.
String
getQNameLocal(String qName)
Return local part of qname.
String
getQNameUri(String qName)
Return uri part of qname.
String
getRawName()
Returns the raw name (prefix + ':' + localName) of the current element (current event must be START_TAG or END_TAG)
boolean
isAllowedMixedContent()
Is mixed element context allowed?
boolean
isNamespaceAttributesReporting()
Is parser going to report namespace attributes (xmlns*) ?
boolean
isNamespaceAware()
Is parser namespace aware?
boolean
isWhitespaceContent()
Check if last CONTENT contained only whitespace characters.
byte
next()
Get next parsing event.
String
readContent()
Read current content as Stirng.
void
readEndTag(XmlEndTag etag)
Read current end tag.
void
readNamespacesPrefixes(int depth, String[] prefixes, int off, int len)
Return namespace prefixes for element at depth
void
readNamespacesUris(int depth, String[] uris, int off, int len)
Return namespace URIs for element at depth
byte
readNode(XmlNode node)
Read subtree into node: call readNodeWithoutChildren and then parse subtree adding children (values obtained with readXontent or readNodeWithoutChildren).
void
readNodeWithoutChildren(XmlNode node)
Read node: it calls readStartTag and then if parser is namespaces aware currently declared nemaspeces will be added and defaultNamespace will be set.
void
readStartTag(XmlStartTag stag)
Read current start tag.
void
reset()
Reset the parser state.
void
setAllowedMixedContent(boolean enable)
Allow for mixed element content.
void
setInput(Reader in)
Set the input for parser.
void
setInput(char[] buf)
Set the input for parser.
void
setInput(char[] buf, int off, int len)
Set the input for parser.
void
setNamespaceAttributesReporting(boolean enable)
Make parser to report xmlns* attributes.
void
setNamespaceAware(boolean enable)
Indicate that the parser understands XML Namespaces

NOTE: this is not resetable parameter.

byte
skipNode()
Goes directly to the next sibling

NOTE: parser must be on START_TAG event.

Field Details

CONTENT

public static final byte CONTENT
element content was just read
Field Value:
4

END_DOCUMENT

public static final byte END_DOCUMENT
signal logical end of xml document
Field Value:
1

END_TAG

public static final byte END_TAG
end tag was just read
Field Value:
3

START_TAG

public static final byte START_TAG
start tag was just read
Field Value:
2

Method Details

getColumnNumber

public int getColumnNumber()

getContentLength

public int getContentLength()
            throws XmlPullParserException
Return how big is content.

NOTE: parser must be on CONTENT event.


getDepth

public int getDepth()
Returns the current depth of the element.

getEventType

public byte getEventType()
            throws XmlPullParserException
Returns the type of the current element (START_TAG, END_TAG, CONTENT, etc)

getLineNumber

public int getLineNumber()

getLocalName

public String getLocalName()
Returns the local name of the current element (current event must be START_TAG or END_TAG)

getNamespaceUri

public String getNamespaceUri()
Returns the namespace URI of the current element Returns null if not applicable (current event must be START_TAG or END_TAG)

getNamespacesLength

public int getNamespacesLength(int depth)

getPosDesc

public String getPosDesc()

getPrefix

public String getPrefix()
Returns the prefix of the current element or null if elemet has no prefix. (current event must be START_TAG or END_TAG)

getQNameLocal

public String getQNameLocal(String qName)
            throws XmlPullParserException
Return local part of qname. For example for 'xsi:type' it returns 'type'.

getQNameUri

public String getQNameUri(String qName)
            throws XmlPullParserException
Return uri part of qname. It is depending on current state of parser to find what namespace uri is mapped from namespace prefix. For example for 'xsi:type' if xsi namespace prefix was declared to 'urn:foo' it will return 'urn:foo'.

getRawName

public String getRawName()
Returns the raw name (prefix + ':' + localName) of the current element (current event must be START_TAG or END_TAG)

isAllowedMixedContent

public boolean isAllowedMixedContent()
Is mixed element context allowed?

isNamespaceAttributesReporting

public boolean isNamespaceAttributesReporting()
Is parser going to report namespace attributes (xmlns*) ?

isNamespaceAware

public boolean isNamespaceAware()
Is parser namespace aware?

isWhitespaceContent

public boolean isWhitespaceContent()
            throws XmlPullParserException
Check if last CONTENT contained only whitespace characters.

next

public byte next()
            throws XmlPullParserException,
                   IOException
Get next parsing event.

NOTE: empty element (such as <tag/>) will be reported with just two events: START_TAG, END_TAG - it must be so to preserve parsing equivalency of empty element to <tag></tag>.


readContent

public String readContent()
            throws XmlPullParserException
Read current content as Stirng.

NOTE: parser must be on CONTENT event.


readEndTag

public void readEndTag(XmlEndTag etag)
            throws XmlPullParserException
Read current end tag.

NOTE: parser must be on END_TAG event.


readNamespacesPrefixes

public void readNamespacesPrefixes(int depth,
                                   String[] prefixes,
                                   int off,
                                   int len)
            throws XmlPullParserException
Return namespace prefixes for element at depth

readNamespacesUris

public void readNamespacesUris(int depth,
                               String[] uris,
                               int off,
                               int len)
            throws XmlPullParserException
Return namespace URIs for element at depth

readNode

public byte readNode(XmlNode node)
            throws XmlPullParserException,
                   IOException
Read subtree into node: call readNodeWithoutChildren and then parse subtree adding children (values obtained with readXontent or readNodeWithoutChildren).

NOTE: parser must be on START_TAG event. and all events will written into node!


readNodeWithoutChildren

public void readNodeWithoutChildren(XmlNode node)
            throws XmlPullParserException
Read node: it calls readStartTag and then if parser is namespaces aware currently declared nemaspeces will be added and defaultNamespace will be set.

NOTE: parser must be on START_TAG event. and all events will written into node!


readStartTag

public void readStartTag(XmlStartTag stag)
            throws XmlPullParserException
Read current start tag.

NOTE: parser must be on START_TAG event.


reset

public void reset()
            throws XmlPullParserException
Reset the parser state.

setAllowedMixedContent

public void setAllowedMixedContent(boolean enable)
            throws XmlPullParserException
Allow for mixed element content. Disabled by default. When disbaled element must containt either text or other elements.

NOTE: this is not resetable parameter.


setInput

public void setInput(Reader in)
            throws XmlPullParserException
Set the input for parser.

setInput

public void setInput(char[] buf)
            throws XmlPullParserException
Set the input for parser.

setInput

public void setInput(char[] buf,
                     int off,
                     int len)
            throws XmlPullParserException
Set the input for parser.

setNamespaceAttributesReporting

public void setNamespaceAttributesReporting(boolean enable)
            throws XmlPullParserException
Make parser to report xmlns* attributes. Disabled by default. Only meaningful when namespaces are enabled (when namespaces are disabled all attributes are always reported).

setNamespaceAware

public void setNamespaceAware(boolean enable)
            throws XmlPullParserException
Indicate that the parser understands XML Namespaces

NOTE: this is not resetable parameter.


skipNode

public byte skipNode()
            throws XmlPullParserException,
                   IOException
Goes directly to the next sibling

NOTE: parser must be on START_TAG event. and all intermittent events will be lost!


Copyright (c) 2003 IU Extreme! Lab http://www.extreme.indiana.edu/ All Rights Reserved.

Note this package is deprecated by XPP3 that implements XmlPull API