Alphabetical Index

A C D E G I M N O P R S W X

A

parameters modeled after SAX2 attribute approach
Parameter isNamespaceDeclaration if true indicates that attribute is related to namespace management and may be ignored by normal processing

NOTE: this class has no support for resolving namespaces and such support may be added later (see XmlNode and namespaces methids)

NOTE: node SHOULD NOT keep references to passed arrays!
addNamespaceDeclaration(String,String) - method in class org.gjt.xpp.XmlNode
appendChild(Object) - method in class org.gjt.xpp.XmlNode

C

children() - method in class org.gjt.xpp.XmlNode
children() - method in class org.gjt.xpp.XmlPullNode
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...
column - field in class org.gjt.xpp.XmlPullParserException
CONTENT - static field in class org.gjt.xpp.XmlPullParser
element content was just read

D

DEFAULT_PROPERTY_NAME - static field in class org.gjt.xpp.XmlPullParserFactory
detail - field in class org.gjt.xpp.XmlPullParserException

E

END_DOCUMENT - static field in class org.gjt.xpp.XmlPullParser
signal logical end of xml document
END_TAG - static field in class org.gjt.xpp.XmlPullParser
end tag was just read
ensureAttributesCapacity(int) - method in class org.gjt.xpp.XmlStartTag
Pre-allocate if necessary tag data structure to hold at least minCapacity attributes .
ensureChildrenCapacity(int) - method in class org.gjt.xpp.XmlNode
ensureDeclaredNamespacesCapacity(int) - method in class org.gjt.xpp.XmlNode

G

getAttributeCount() - method in class org.gjt.xpp.XmlStartTag
Returns the number of attributes on the current element
getAttributeLocalName(int) - method in class org.gjt.xpp.XmlStartTag
Returns the localname of the specified attribute if namespaces enabled or just attribute name if namespaces disabled.
getAttributeNamespaceUri(int) - method in class org.gjt.xpp.XmlStartTag
Returns the namespace URI of the specified attribute number index (starts from 0).
getAttributePrefix(int) - method in class org.gjt.xpp.XmlStartTag
Returns the prefix of the specified attribute Returns null if invalid index or if element has no prefix.
getAttributeRawName(int) - method in class org.gjt.xpp.XmlStartTag
Returns the raw name of the specified attribute Returns null if invalid index.
getAttributeValue(int) - method in class org.gjt.xpp.XmlStartTag
Returns the given attributes value Returns null if invalid index.
Returns the given attributes value
Returns the given attributes value Returns null if no attribute with rawName.
getChildAt(int) - method in class org.gjt.xpp.XmlNode
getChildrenCount() - method in class org.gjt.xpp.XmlNode
it may need to reconsruct whole subtree to get count ...
getChildrenCountSoFar() - method in class org.gjt.xpp.XmlPullNode
getColumnNumber() - method in class org.gjt.xpp.XmlPullParser
getColumnNumber() - method in class org.gjt.xpp.XmlPullParserException
getContentLength() - method in class org.gjt.xpp.XmlPullParser
Return how big is content.
getDeclaredNamespaceLength() - method in class org.gjt.xpp.XmlNode
getDefaultNamespaceUri() - method in class org.gjt.xpp.XmlNode
Namesapce URI associated with default namesapce prefix (xmlns='....')
getDepth() - method in class org.gjt.xpp.XmlPullParser
Returns the current depth of the element.
getDetail() - method in class org.gjt.xpp.XmlPullParserException
getEventBuffer() - method in class org.gjt.xpp.XmlPullParserEventPosition
NOTE: This may be internal buffer and is valud only until call to method next()- do NOT attempt modify !
getEventEnd() - method in class org.gjt.xpp.XmlPullParserEventPosition
getEventStart() - method in class org.gjt.xpp.XmlPullParserEventPosition
getEventType() - method in class org.gjt.xpp.XmlPullParser
Returns the type of the current element (START_TAG, END_TAG, CONTENT, etc)
getHardLimit() - method in class org.gjt.xpp.XmlPullParserBufferControl
getLineNumber() - method in class org.gjt.xpp.XmlPullParser
getLineNumber() - method in class org.gjt.xpp.XmlPullParserException
getLocalName() - method in class org.gjt.xpp.XmlPullParser
Returns the local name of the current element (current event must be START_TAG or END_TAG)
getLocalName() - method in class org.gjt.xpp.XmlTag
Returns the local name of the current element
getMessage() - method in class org.gjt.xpp.XmlPullParserException
getNamespacesLength(int) - method in class org.gjt.xpp.XmlPullParser
getNamespaceUri() - method in class org.gjt.xpp.XmlPullParser
Returns the namespace URI of the current element Returns null if not applicable (current event must be START_TAG or END_TAG)
getNamespaceUri() - method in class org.gjt.xpp.XmlTag
Returns the namespace URI of the current element Returns null if not applicable
getOutput() - method in class org.gjt.xpp.XmlRecorder
getParentNode() - method in class org.gjt.xpp.XmlNode
getPosDesc() - method in class org.gjt.xpp.XmlPullParser
getPrefix() - method in class org.gjt.xpp.XmlPullParser
Returns the prefix of the current element or null if elemet has no prefix.
getPrefix() - method in class org.gjt.xpp.XmlTag
Returns the prefix of the current element or null if elemet has no prefix.
getPullParser() - method in class org.gjt.xpp.XmlPullNode
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!!!!).
getQNameLocal(String) - method in class org.gjt.xpp.XmlNode
Return local part of qname.
getQNameLocal(String) - method in class org.gjt.xpp.XmlPullParser
Return local part of qname.
getQNameUri(String) - method in class org.gjt.xpp.XmlNode
Return uri part of qname.
getQNameUri(String) - method in class org.gjt.xpp.XmlPullParser
Return uri part of qname.
getRawName() - method in class org.gjt.xpp.XmlPullParser
Returns the raw name (prefix + ':' + localName) of the current element (current event must be START_TAG or END_TAG)
getRawName() - method in class org.gjt.xpp.XmlTag
Returns the raw name (prefix + ':' + localName) of the current element
getSoftLimit() - method in class org.gjt.xpp.XmlPullParserBufferControl

I

insertChildAt(int,Object) - method in class org.gjt.xpp.XmlNode
isAllowedMixedContent() - method in class org.gjt.xpp.XmlPullParser
Is mixed element context allowed?
Return true if attribute at index is namespace declaration such as xmlns='...' or xmlns:prefix='...'
isBufferShrinkable() - method in class org.gjt.xpp.XmlPullParserBufferControl
isEndTagNewLine() - method in class org.gjt.xpp.XmlFormatter
Should new line be added after end tag?
isFinished() - method in class org.gjt.xpp.XmlPullNode
Is pull parsing of node finished.
isNamespaceAttributesReporting() - method in class org.gjt.xpp.XmlPullParser
Is parser going to report namespace attributes (xmlns*) ?
isNamespaceAware() - method in class org.gjt.xpp.XmlPullParser
Is parser namespace aware?
isNamespaceAware() - method in class org.gjt.xpp.XmlPullParserFactory
Indicates whether or not the factory is configured to produce parsers which are namespace aware.
isWhitespaceContent() - method in class org.gjt.xpp.XmlPullParser
Check if last CONTENT contained only whitespace characters.

M

modifyTag(String,String,String) - method in class org.gjt.xpp.XmlTag
Modify tag to have namespace URI, localName and rawName.

N

namespace2Prefix(String) - method in class org.gjt.xpp.XmlNode
return prefix for namesapce searching node tree upward.
newEndTag() - method in class org.gjt.xpp.XmlPullParserFactory
Create new end tag.
newFormatter() - method in class org.gjt.xpp.XmlPullParserFactory
Return new XML formatter.
newInstance() - static method in class org.gjt.xpp.XmlPullParserFactory
Get a new instance of a PullParserFactory used to create XPP.
newInstance(Class) - static method in class org.gjt.xpp.XmlPullParserFactory
Get a new instance of a PullParserFactory used to create XPP.
newInstance(String) - static method in class org.gjt.xpp.XmlPullParserFactory
Get a new instance of a PullParserFactory from given class name.
newNode() - method in class org.gjt.xpp.XmlNode
context sensitive factory method to create the same type of node
newNode() - method in class org.gjt.xpp.XmlPullNode
context sensitive factory method to create the same type of node
newNode() - method in class org.gjt.xpp.XmlPullParserFactory
Return new XML node.
Return new XML node that is represeting tree from current pull parser start tag.
newNode(String,String) - method in class org.gjt.xpp.XmlNode
Return new XML pull node that is represeting tree from current pull parser start tag.
newPullParser() - method in class org.gjt.xpp.XmlPullParserFactory
Create new XML pull parser.
newRecorder() - method in class org.gjt.xpp.XmlPullParserFactory
Return new XML recorder.
newStartTag() - method in class org.gjt.xpp.XmlPullParserFactory
Return new XML start tag.
next() - method in class org.gjt.xpp.XmlPullParser
Get next parsing event.

O

org.gjt.xpp - package
This package defines classes compromising public API of XML Pull Parser 2.0 (org.gjt.xpp).

P

prefix2Namespace(String) - method in class org.gjt.xpp.XmlNode
return namespace for prefix searching node tree upward.
printStackTrace() - method in class org.gjt.xpp.XmlPullParserException

R

readChildren() - method in class org.gjt.xpp.XmlPullNode
Read all reminaing children up to end tag.
readContent() - method in class org.gjt.xpp.XmlPullParser
Read current content as Stirng.
readDeclaredPrefixes(String[],int,int) - method in class org.gjt.xpp.XmlNode
readEndTag(org.gjt.xpp.XmlEndTag) - method in class org.gjt.xpp.XmlPullParser
Read current end tag.
Return namespace prefixes for element at depth
Return namespace URIs for element at depth
readNextChild() - method in class org.gjt.xpp.XmlPullNode
This is preferred method to pull children (children() requires .wrapping object Enumeration).
readNode(org.gjt.xpp.XmlNode) - method in class org.gjt.xpp.XmlPullParser
Read subtree into node: call readNodeWithoutChildren and then parse subtree adding children (values obtained with readXontent or readNodeWithoutChildren).
readNode(Reader) - method in class org.gjt.xpp.XmlPullParserFactory
Equivalent to calling readNode(reader, false);
readNode(Reader,boolean) - method in class org.gjt.xpp.XmlPullParserFactory
Read XmlNode from input - essentially it is utility function that will create instance of pull parser, feed input inpt it and return new node tree parsed form the input.
Read node: it calls readStartTag and then if parser is namespaces aware currently declared nemaspeces will be added and defaultNamespace will be set.
Read current start tag.
This method tries to remove attribute identified by namespace uti and local name.
removeAttributeByRawName(String) - method in class org.gjt.xpp.XmlStartTag
This method tries to remove attribute identified by raw name.
removeAttributes() - method in class org.gjt.xpp.XmlStartTag
remove all atribute
removeChildAt(int) - method in class org.gjt.xpp.XmlNode
removeChildren() - method in class org.gjt.xpp.XmlNode
Removes all children - every child that was implementing XmlNode will have set parent to null.
removeDeclaredNamespaces() - method in class org.gjt.xpp.XmlNode
replaceChildAt(int,Object) - method in class org.gjt.xpp.XmlNode
reset() - method in class org.gjt.xpp.XmlPullParser
Reset the parser state.
resetEndTag() - method in class org.gjt.xpp.XmlEndTag
resetNode() - method in class org.gjt.xpp.XmlNode
Clear all Tag state to default values.
resetPullNode() - method in class org.gjt.xpp.XmlPullNode
resetStartTag() - method in class org.gjt.xpp.XmlStartTag
Clear all Tag state to default values.
resetTag() - method in class org.gjt.xpp.XmlTag
Clear all Tag state to default values.
row - field in class org.gjt.xpp.XmlPullParserException

S

setAllowedMixedContent(boolean) - method in class org.gjt.xpp.XmlPullParser
Allow for mixed element content.
setDefaultNamespaceUri(String) - method in class org.gjt.xpp.XmlNode
Set default namesapce URI (xmlns='....')
setDetail(Throwable) - method in class org.gjt.xpp.XmlPullParserException
setEndTagNewLine(boolean) - method in class org.gjt.xpp.XmlFormatter
Should new line be added after end tag?

NOTE: setting it to true will affect output XML parsing when there are elements with mixed content allowed!

setHardLimit(int) - method in class org.gjt.xpp.XmlPullParserBufferControl
setInput(char[]) - method in class org.gjt.xpp.XmlPullParser
Set the input for parser.
setInput(char[],int,int) - method in class org.gjt.xpp.XmlPullParser
Set the input for parser.
setInput(Reader) - method in class org.gjt.xpp.XmlPullParser
Set the input for parser.
Make parser to report xmlns* attributes.
setNamespaceAware(boolean) - method in class org.gjt.xpp.XmlPullParser
Indicate that the parser understands XML Namespaces

NOTE: this is not resetable parameter.

setNamespaceAware(boolean) - method in class org.gjt.xpp.XmlPullParserFactory
Specifies that the parser produced by this factory will provide support for XML namespaces.
setOutput(Writer) - method in class org.gjt.xpp.XmlRecorder
setParentNode(org.gjt.xpp.XmlNode) - method in class org.gjt.xpp.XmlNode
Reset pull node to use pull parser.
setSoftLimit(int) - method in class org.gjt.xpp.XmlPullParserBufferControl
skipChildren() - method in class org.gjt.xpp.XmlPullNode
skipNode() - method in class org.gjt.xpp.XmlPullParser
Goes directly to the next sibling

NOTE: parser must be on START_TAG event.

START_TAG - static field in class org.gjt.xpp.XmlPullParser
start tag was just read

W

write(Object) - method in class org.gjt.xpp.XmlRecorder
writeContent(String) - method in class org.gjt.xpp.XmlRecorder
writeEndTag(org.gjt.xpp.XmlEndTag) - method in class org.gjt.xpp.XmlRecorder
writeNode(org.gjt.xpp.XmlNode) - method in class org.gjt.xpp.XmlRecorder
Equivalent to calling writeNode(node, writer, false);
writeXml(org.gjt.xpp.XmlWritable) - method in class org.gjt.xpp.XmlRecorder
writeXml(Writer) - method in class org.gjt.xpp.XmlWritable

X

XmlEndTag - interface org.gjt.xpp.XmlEndTag
This represent XML end tag.
XmlFormatter - interface org.gjt.xpp.XmlFormatter
This interface extends XmlRecorder to give some control over formattingof XML output.
XmlNode - interface org.gjt.xpp.XmlNode
This class represents XML subtree.
XmlPullNode - interface org.gjt.xpp.XmlPullNode
This class represents pullable XML subtree - children are built on demand.
XmlPullParser - interface org.gjt.xpp.XmlPullParser
Generic interface for simple and quick XML Pull Parser.
Additional interface to control XML Pull Parser buffering.
Special interface to retrieve event positioning information.
This exception is thrown to signal XML Pull Parser related excepions.
XmlPullParserException() - constructor for class org.gjt.xpp.XmlPullParserException
XmlPullParserException(String) - constructor for class org.gjt.xpp.XmlPullParserException
XmlPullParserException(Throwable) - constructor for class org.gjt.xpp.XmlPullParserException
This class is used to create implementations of XML Pull Parser.
XmlPullParserFactory() - constructor for class org.gjt.xpp.XmlPullParserFactory
Proteted constructor to be called by factory implementations.
XmlRecorder - interface org.gjt.xpp.XmlRecorder
This class represents abstract functionality necessary to to persist XML Pull Parser events.
XmlStartTag - interface org.gjt.xpp.XmlStartTag
This class represents abstract functionality necessary to to persist XML Pull Parser events.
XmlTag - interface org.gjt.xpp.XmlTag
Base interface that encapsulates common functionality for XML elements: both start tag and end tag (an empty element is equivalent to start tag followed by end tag so for simplicity ti is not modeled as a separate class).
XmlWritable - interface org.gjt.xpp.XmlWritable
This interface can be used by classes that wishes to implement its own way to persist XML into writer.

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