org.gjt.xpp

Interface XmlPullNode

All Superinterfaces:
XmlNode, XmlStartTag, XmlTag
Known Implementing Classes:
PullNode

public interface XmlPullNode
extends XmlNode

This class represents pullable XML subtree - children are built on demand.
Author:
Aleksander Slominski
See Also:
XmlNode

Method Summary

Enumeration
children()
This is not recommened method to pull children when node is not finished (use readNextChild() instead) as Enumeration interface does not allow to throw XmlPullParserException so any parsing exeption is wrapped into RuntimeException making code more messy...
int
getChildrenCountSoFar()
XmlPullParser
getPullParser()
Get parser that is use to build this node tree and this pull node becomes finished - the caller is responsibile to move pull parser state to the end tag of this node (or parent pull node will be left in unconsistent state!!!!).
boolean
isFinished()
Is pull parsing of node finished.
XmlNode
newNode()
context sensitive factory method to create the same type of node
XmlPullNode
newPullNode(XmlPullParser pp)
void
readChildren()
Read all reminaing children up to end tag.
Object
readNextChild()
This is preferred method to pull children (children() requires .wrapping object Enumeration).
void
resetPullNode()
void
setPullParser(XmlPullParser pp)
Reset pull node to use pull parser.
void
skipChildren()

Methods inherited from interface org.gjt.xpp.XmlNode

addDeclaredNamespaces, addNamespaceDeclaration, appendChild, children, ensureChildrenCapacity, ensureDeclaredNamespacesCapacity, getChildAt, getChildrenCount, getDeclaredNamespaceLength, getDefaultNamespaceUri, getParentNode, getQNameLocal, getQNameUri, insertChildAt, namespace2Prefix, newNode, newNode, prefix2Namespace, readDeclaredNamespaceUris, readDeclaredPrefixes, removeChildAt, removeChildren, removeDeclaredNamespaces, replaceChildAt, resetNode, setDefaultNamespaceUri, setParentNode

Methods inherited from interface org.gjt.xpp.XmlStartTag

addAttribute, addAttribute, ensureAttributesCapacity, getAttributeCount, getAttributeLocalName, getAttributeNamespaceUri, getAttributePrefix, getAttributeRawName, getAttributeValue, getAttributeValueFromName, getAttributeValueFromRawName, isAttributeNamespaceDeclaration, removeAttributeByName, removeAttributeByRawName, removeAttributes, resetStartTag

Methods inherited from interface org.gjt.xpp.XmlTag

getLocalName, getNamespaceUri, getPrefix, getRawName, modifyTag, resetTag

Method Details

children

public Enumeration children()
This is not recommened method to pull children when node is not finished (use readNextChild() instead) as Enumeration interface does not allow to throw XmlPullParserException so any parsing exeption is wrapped into RuntimeException making code more messy...
Specified by:
children in interface XmlNode

getChildrenCountSoFar

public int getChildrenCountSoFar()

getPullParser

public XmlPullParser getPullParser()
            throws IOException,
                   XmlPullParserException
Get parser that is use to build this node tree and this pull node becomes finished - the caller is responsibile to move pull parser state to the end tag of this node (or parent pull node will be left in unconsistent state!!!!). The returned pull parser position will be before start tag of next child or before final end tag and the caller should use next() to move parser to start reading children. The node state becomes finished and subsequent call to this method will throw exception until setPullParser() is called. The final effect should be equivalen to calling skipNode()!

NOTE: this pull node must be in unfinished state or exception will be thrown


isFinished

public boolean isFinished()
Is pull parsing of node finished.

newNode

public XmlNode newNode()
            throws XmlPullParserException
context sensitive factory method to create the same type of node
Specified by:
newNode in interface XmlNode

newPullNode

public XmlPullNode newPullNode(XmlPullParser pp)
            throws XmlPullParserException

readChildren

public void readChildren()
            throws XmlPullParserException,
                   IOException
Read all reminaing children up to end tag.

readNextChild

public Object readNextChild()
            throws XmlPullParserException,
                   IOException
This is preferred method to pull children (children() requires .wrapping object Enumeration).
Returns:
next child (which is String or XmlPullNode) or null if there is no re children
See Also:
children()

resetPullNode

public void resetPullNode()

setPullParser

public void setPullParser(XmlPullParser pp)
            throws XmlPullParserException
Reset pull node to use pull parser. Pull Parser must be on START_TAG

skipChildren

public void skipChildren()
            throws XmlPullParserException,
                   IOException

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