org.gjt.xpp

Interface XmlPullParser

public interface XmlPullParser

Generic interface for simple and quick XML Pull Parser.

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)
int	getNamespacesLength(int depth)
String	getNamespaceUri() Returns the namespace URI of the current element Returns null if not applicable (current event must be START_TAG or END_TAG)
String	getPosDesc()
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)
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. and all intermittent events will be lost!

Field Detail

CONTENT

public static final byte CONTENT

element content was just read

END_DOCUMENT

public static final byte END_DOCUMENT

signal logical end of xml document

END_TAG

public static final byte END_TAG

end tag was just read

START_TAG

public static final byte START_TAG

start tag was just read

Method Detail

getContentLength

public int getContentLength()

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()

Returns the type of the current element (START_TAG, END_TAG, CONTENT, etc)

getLocalName

public String getLocalName()

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

getNamespacesLength

public int getNamespacesLength(int depth)

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)

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)

Return local part of qname. For example for 'xsi:type' it returns 'type'.

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()

Check if last CONTENT contained only whitespace characters.

public byte next()

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()

Read current content as Stirng.

NOTE: parser must be on CONTENT event.

readEndTag

public void readEndTag(XmlEndTag etag)

Read current end tag.

NOTE: parser must be on END_TAG event.

readNamespacesPrefixes

public void readNamespacesPrefixes(int depth, String[] prefixes, int off, int len)

Return namespace prefixes for element at depth

readNamespacesUris

public void readNamespacesUris(int depth, String[] uris, int off, int len)

Return namespace URIs for element at depth

readNode

public byte readNode(XmlNode node)

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)

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)

Read current start tag.

NOTE: parser must be on START_TAG event.

reset

public void reset()

Reset the parser state.

setAllowedMixedContent

public void setAllowedMixedContent(boolean enable)

Allow for mixed element content. Disabled by default. When disbaled element must containt either text or other elements.

NOTE: this is not resetable parameter.

skipNode

public byte skipNode()

Goes directly to the next sibling

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