public Interface XmlPullParser

A CDATA sections was just read; this token is available only from calls to nextToken(). A call to next() will accumulate various text events into a single event of type TEXT. The text contained in the CDATA section is available by callling getText().

See Also

nextToken, getText

An XML comment was just read. This event type is this token is available via nextToken() only; calls to next() will skip comments automatically. The content of the comment can be accessed using the getText() method.

See Also

nextToken, getText

An XML document type declaration was just read. This token is available from nextToken() only. The unparsed text inside the doctype is available via the getText() method.

See Also

nextToken, getText

Logical end of the xml document. Returned from getEventType, next() and nextToken() when the end of the input document has been reached.

See Also

next, nextToken

Returned from getEventType(), next(), or nextToken() when an end tag was read. The name of start tag is available from getName(), its namespace and prefix are available from getNamespace() and getPrefix().

See Also

next, nextToken, getName, getPrefix, getNamespace, FEATURE_PROCESS_NAMESPACES

An entity reference was just read; this token is available from nextToken() only. The entity name is available by calling getName(). If available, the replacement text can be obtained by calling getTextt(); otherwise, the user is responsibile for resolving the entity reference. This event type is never returned from next(); next() will accumulate the replacement text and other text events to a single TEXT event.

See Also

nextToken, getText

This feature determines whether the document declaration is processed. If set to false, the DOCDECL event type is reported by nextToken() and ignored by next(). If this featue is activated, then the document declaration must be processed by the parser.

See Also

getFeature, setFeature

This feature determines whether the parser processes namespaces. As for all features, the default value is false.

See Also

getFeature, setFeature

This feature determines whether namespace attributes are exposed via the attribute access methods. Like all features, the default value is false. This feature cannot be changed during parsing.

See Also

getFeature, setFeature

If this feature is activated, all validation errors as defined in the XML 1.0 sepcification are reported. This implies that FEATURE_PROCESS_DOCDECL is true and both, the internal and external document type declaration will be processed.

See Also

getFeature, setFeature

Ignorable whitespace was just read. This token is available only from nextToken()). For non-validating parsers, this event is only reported by nextToken() when outside the root element. Validating parsers may be able to detect ignorable whitespace at other locations. The ignorable whitespace string is available by calling getText()

See Also

nextToken, getText

This constant represents the default namespace (empty string "")

An XML processing instruction declaration was just read. This event type is available only via nextToken(). getText() will return text that is inside the processing instruction. Calls to next() will skip processing instructions automatically.

See Also

nextToken, getText

Signalize that parser is at the very beginning of the document and nothing was read yet. This event type can only be observed by calling getEvent() before the first call to next(), nextToken, or nextTag()).

See Also

next, nextToken

Returned from getEventType(), next(), nextToken() when a start tag was read. The name of start tag is available from getName(), its namespace and prefix are available from getNamespace() and getPrefix() if namespaces are enabled. See getAttribute* methods to retrieve element attributes. See getNamespace* methods to retrieve newly declared namespaces.

See Also

next, nextToken, getName, getPrefix, getNamespace, getAttributeCount, getDepth, getNamespaceCount, FEATURE_PROCESS_NAMESPACES

Character data was read and will is available by calling getText().

See Also

next, nextToken, getText

This array can be used to convert the event type integer constants such as START_TAG or TEXT to to a string. For example, the value of TYPES[START_TAG] is the string "START_TAG". This array is intended for diagnostic output only. Relying on the contents of the array may be dangerous since malicous applications may alter the array, although it is final, due to limitations of the Java language.

Set new value for entity replacement text as defined in XML 1.0 Section 4.5 Construction of Internal Entity Replacement Text. If FEATURE_PROCESS_DOCDECL or FEATURE_VALIDATION are set, calling this function will result in an exception -- when processing of DOCDECL is enabled, there is no need to the entity replacement text manually.

The motivation for this function is to allow very small implementations of XMLPULL that will work in J2ME environments. Though these implementations may not be able to process the document type declaration, they still can work with known DTDs by using this function.

Please notes: The given value is used literally as replacement text and it corresponds to declaring entity in DTD that has all special characters escaped: left angle bracket is replaced with <, ampersnad with & and so on.

See Also

setInput, FEATURE_PROCESS_DOCDECL, FEATURE_VALIDATION

Returns the number of attributes of the current start tag, or -1 if the current event type is not START_TAG

See Also

getAttributeNamespace, getAttributeName, getAttributePrefix, getAttributeValue

Returns the local name of the specified attribute if namespaces are enabled or just attribute name if namespaces are disabled. Throws an IndexOutOfBoundsException if the index is out of range or current event type is not START_TAG.

Parameters

index:int

zero based index of attribute

Returns:String

attribute name (null is never returned)

Returns the namespace URI of the attribute with the given index (starts from 0). Returns an empty string ("") if namespaces are not enabled or the attribute has no namespace. Throws an IndexOutOfBoundsException if the index is out of range or the current event type is not START_TAG.

Parameters

index:int

zero based index of attribute

Returns:String

attribute namespace, empty string ("") is returned if namesapces processing is not enabled or namespaces processing is enabled but attribute has no namespace (it has no prefix).

Returns the prefix of the specified attribute Returns null if the element has no prefix. If namespaces are disabled it will always return null. Throws an IndexOutOfBoundsException if the index is out of range or current event type is not START_TAG.

Parameters

index:int

zero based index of attribute

Returns:String

attribute prefix or null if namespaces processing is not enabled.

Returns the type of the specified attribute If parser is non-validating it MUST return CDATA.

Parameters

index:int

zero based index of attribute

Returns:String

attribute type (null is never returned)

Returns the given attributes value. Throws an IndexOutOfBoundsException if the index is out of range or current event type is not START_TAG.

Parameters

index:int

zero based index of attribute

Returns:String

value of attribute (null is never returned)

See Also

defineEntityReplacementText

Returns the attributes value identified by namespace URI and namespace localName. If namespaces are disabled namespace must be null. If current event type is not START_TAG then IndexOutOfBoundsException will be thrown.

Parameters

namespace:String

Namespace of the attribute if namespaces are enabled otherwise must be null

name:String

If namespaces enabled local name of attribute otherwise just attribute name

Returns:String

value of attribute or null if attribute with given name does not exist

See Also

defineEntityReplacementText

Returns the current column number, starting from 0. When the parser does not know the current column number or can not determine it, -1 is returned (e.g. for WBXML).

Returns:int

current column number or -1 if unknown.

Returns the current depth of the element. Outside the root element, the depth is 0. The depth is incremented by 1 when a start tag is reached. The depth is decremented AFTER the end tag event was observed.

<!-- outside -->     0
<root>               1
  sometext                 1
    <foobar>         2
    </foobar>        2
</root>              1
<!-- outside -->     0

Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)

See Also

next(), nextToken()

Returns the current value of the given feature.

Parameters

name:String

The name of feature to be retrieved.

Returns:boolean

The value of the feature.

Exceptions

IllegalArgumentException:

if string the feature name is null

Returns the input encoding if known, null otherwise. If setInput(InputStream, inputEncoding) was called with an inputEncoding value other than null, this value must be returned from this method. Otherwise, if inputEncoding is null and the parser suppports the encoding detection feature (http://xmlpull.org/v1/doc/features.html#detect-encoding), it must return the detected encoding. If setInput(Reader) was called, null is returned. After first call to next if XML declaration was present this method will return encoding declared.

Returns the current line number, starting from 1. When the parser does not know the current line number or can not determine it, -1 is returned (e.g. for WBXML).

Returns:int

current line number or -1 if unknown.

For START_TAG or END_TAG events, the (local) name of the current element is returned when namespaces are enabled. When namespace processing is disabled, the raw name is returned. For ENTITY_REF events, the entity name is returned. If the current event is not START_TAG, END_TAG, or ENTITY_REF, null is returned.

Returns the URI corresponding to the given prefix, depending on current state of the parser.

If the prefix was not declared in the current scope, null is returned. The default namespace is included in the namespace table and is available via getNamespace (null).

This method is a convenience method for

 for (int i = getNamespaceCount(getDepth ())-1; i >= 0; i--) {
  if (getNamespacePrefix(i).equals( prefix )) {
    return getNamespaceUri(i);
  }
 }
 return null;

See Also

getNamespaceCount, getNamespacePrefix, getNamespaceUri

Returns the namespace URI of the current element. The default namespace is represented as empty string. If namespaces are not enabled, an empty String ("") is always returned. The current event must be START_TAG or END_TAG; otherwise, null is returned.

Returns the numbers of elements in the namespace stack for the given depth. If namespaces are not enabled, 0 is returned.

      XmlPullParser pp = ...
      int nsStart = pp.getNamespaceCount(pp.getDepth()-1);
      int nsEnd = pp.getNamespaceCount(pp.getDepth());
      for (int i = nsStart; i < nsEnd; i++) {
         String prefix = pp.getNamespacePrefix(i);
         String ns = pp.getNamespaceUri(i);
          // ...
     }

See Also

getNamespacePrefix, getNamespaceUri, getNamespace(), getNamespace(String)

Returns the namespace prefixe for the given position in the namespace stack. Default namespace declaration (xmlns='...') will have null as prefix. If the given index is out of range, an exception is thrown.

Returns the namespace URI for the given position in the namespace stack If the position is out of range, an exception is thrown.

Returns a short text describing the current parser state, including the position, a description of the current event and the data source if known. This method is especially useful to provide meaningful error messages and for debugging purposes.

Returns the prefix of the current element. If the element is in the default namespace (has no prefix), null is returned. If namespaces are not enabled, or the current event is not START_TAG or END_TAG, null is returned.

Look up the value of a property. The property name is any fully-qualified URI.

Parameters

name:String

The name of property to be retrieved.

Returns:Object

The value of named property.

Returns the text content of the current event as String. The value returned depends on current event type, for example for TEXT event it is element content (this is typical case when next() is used). See description of nextToken() for detailed description of possible returned values for different types of events.

See Also

getEventType, next, nextToken

Returns the buffer that contains the text of the current event, as well as the start offset and length relevant for the current event. See getText(), next() and nextToken() for description of possible returned values.

Parameters

holderForStartAndLength:int[]

Must hold an 2-element int array into which the start offset and length values will be written.

Returns:char[]

char buffer that contains the text of the current event (null if the current event has no text associated).

See Also

getText, next, nextToken

Returns if the specified attribute was not in input was declared in XML. If parser is non-validating it MUST always return false. This information is part of XML infoset:

Parameters

index:int

zero based index of attribute

Returns:boolean

false if attribute was in input

Returns true if the current event is START_TAG and the tag is degenerated (e.g. <foobar/>).

Checks whether the current TEXT event contains only whitespace characters. For IGNORABLE_WHITESPACE, this is always true. For TEXT and CDSECT, false is returned when the current event text contains at least one non-white space character. For any other event type an exception is thrown.

Get next parsing event - element content wil be coalesced and only one TEXT event must be returned for whole element content (comments and processing instructions will be ignored and emtity references must be expanded or exception mus be thrown if entity reerence can not be exapnded). If element content is empty (content is "") then no TEXT event will be reported.

See Also

isEmptyElementTag, START_TAG, TEXT, END_TAG, END_DOCUMENT

Call next() and return event if it is START_TAG or END_TAG otherwise throw an exception. It will skip whitespace TEXT before actual tag if any.

essentially it does this

  int eventType = next();
  if(eventType == TEXT &&  isWhitespace()) {   // skip whitespace
     eventType = next();
  }
  if (eventType != START_TAG &&  eventType != END_TAG) {
     throw new XmlPullParserException("expected start or end tag", this, null);
  }
  return eventType;

If current event is START_TAG then if next element is TEXT then element content is returned or if next event is END_TAG then empty string is returned, otherwise exception is thrown. After calling this function successfully parser will be positioned on END_TAG.

The motivation for this function is to allow to parse consistently both empty elements and elements that has non empty content, for example for input:

1. <tag>foo</tag>
2. <tag></tag> (which is equivalent to <tag/> both input can be parsed with the same code:

     p.nextTag()
     p.requireEvent(p.START_TAG, "", "tag");
     String content = p.nextText();
     p.requireEvent(p.END_TAG, "", "tag");
   

   This function together with nextTag make it very easy to parse XML that has no mixed content.

   Essentially it does this

    if(getEventType() != START_TAG) {
       throw new XmlPullParserException(
         "parser must be on START_TAG to read next text", this, null);
    }
    int eventType = next();
    if(eventType == TEXT) {
       String result = getText();
       eventType = next();
       if(eventType != END_TAG) {
         throw new XmlPullParserException(
            "event TEXT it must be immediately followed by END_TAG", this, null);
        }
        return result;
    } else if(eventType == END_TAG) {
       return "";
    } else {
       throw new XmlPullParserException(
         "parser must be on START_TAG or TEXT to read text", this, null);
    }
   

This method works similarly to next() but will expose additional event types (COMMENT, CDSECT, DOCDECL, ENTITY_REF, PROCESSING_INSTRUCTION, or IGNORABLE_WHITESPACE) if they are available in input.

If special feature FEATURE_XML_ROUNDTRIP (identified by URI: http://xmlpull.org/v1/doc/features.html#xml-roundtrip) is enabled it is possible to do XML document round trip ie. reproduce exectly on output the XML input using getText(): returned content is always unnormalized (exactly as in input). Otherwise returned content is end-of-line normalized as described XML 1.0 End-of-Line Handling and. Also when this feature is enabled exact content of START_TAG, END_TAG, DOCDECL and PROCESSING_INSTRUCTION is available.

Here is the list of tokens that can be returned from nextToken() and what getText() and getTextCharacters() returns:

START_DOCUMENT

null

END_DOCUMENT

null

START_TAG

null unless FEATURE_XML_ROUNDTRIP enabled and then returns XML tag, ex: <tag attr='val'>

END_TAG

null unless FEATURE_XML_ROUNDTRIP id enabled and then returns XML tag, ex: </tag>

TEXT

return element content.

Note

that element content may be delivered in multiple consecutive TEXT events.

IGNORABLE_WHITESPACE

return characters that are determined to be ignorable white space. If the FEATURE_XML_ROUNDTRIP is enabled all whitespace content outside root element will always reported as IGNORABLE_WHITESPACE otherise rteporting is optional.

Note

that element content may be delevered in multiple consecutive IGNORABLE_WHITESPACE events.

CDSECT

return text inside CDATA (ex. 'fo<o' from <!CDATA[fo<o]]>)

PROCESSING_INSTRUCTION

if FEATURE_XML_ROUNDTRIP is true return exact PI content ex: 'pi foo' from <?pi foo?> otherwise it may be exact PI content or concatenation of PI target, space and data so for example for <?target data?> string "target data" may be returned if FEATURE_XML_ROUNDTRIP is false.

COMMENT

return comment content ex. 'foo bar' from <!--foo bar-->

ENTITY_REF

getText() MUST return entity replacement text if PROCESS_DOCDECL is false otherwise getText() MAY return null, additionally getTextCharacters() MUST return entity name (for example 'entity_name' for &entity_name;)

Note

this is the only place where value returned from getText() and getTextCharacters() are different
NOTE: it is user responsibility to resolve entity reference if PROCESS_DOCDECL is false and there is no entity replacement text set in defineEntityReplacementText() method (getText() will be null)
NOTE: character entities (ex. &#32;) and standard entities such as &amp; &lt; &gt; &quot; &apos; are reported as well and are not reported as TEXT tokens but as ENTITY_REF tokens! This requirement is added to allow to do roundtrip of XML documents!

DOCDECL

if FEATURE_XML_ROUNDTRIP is true or PROCESS_DOCDECL is false then return what is inside of DOCDECL for example it returns:

" titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd"
[<!ENTITY % active.links "INCLUDE">]"

for input document that contained:

<!DOCTYPE titlepage SYSTEM "http://www.foo.bar/dtds/typo.dtd"
[<!ENTITY % active.links "INCLUDE">]>

otherwise if FEATURE_XML_ROUNDTRIP is false and PROCESS_DOCDECL is true then what is returned is undefined (it may be even null)

See Also

next, START_TAG, TEXT, END_TAG, END_DOCUMENT, COMMENT, DOCDECL, PROCESSING_INSTRUCTION, ENTITY_REF, IGNORABLE_WHITESPACE

Test if the current event is of the given type and if the namespace and name do match. null will match any namespace and any name. If the test is not passed, an exception is thrown. The exception text indicates the parser position, the expected event and the current event that is not meeting the requirement.

Essentially it does this

 if (type != getEventType()
 || (namespace != null &&  !namespace.equals( getNamespace () ) )
 || (name != null &&  !name.equals( getName() ) ) )
    throw new XmlPullParserException( "expected "+ TYPES[ type ]+getPositionDescription());

Use this call to change the general behaviour of the parser, such as namespace processing or doctype declaration handling. This method must be called before the first call to next or nextToken. Otherwise, an exception is thrown.

Example: call setFeature(FEATURE_PROCESS_NAMESPACES, true) in order to switch on namespace processing. The initial settings correspond to the properties requested from the XML Pull Parser factory. If none were requested, all feautures are deactivated by default.

Exceptions

XmlPullParserException:

If the feature is not supported or can not be set

IllegalArgumentException:

If string with the feature name is null

Set the input source for parser to the given reader and resets the parser. The event type is set to the initial value START_DOCUMENT. Setting the reader to null will just stop parsing and reset parser state, allowing the parser to free internal resources such as parsing buffers.

Sets the input stream the parser is going to process. This call resets the parser state and sets the event type to the initial value START_DOCUMENT.

Parameters

inputStream:InputStream

contains a raw byte input stream of possibly unknown encoding (when inputEncoding is null).

inputEncoding:String

if not null it MUST be used as encoding for inputStream

Set the value of a property. The property name is any fully-qualified URI.

Exceptions

XmlPullParserException:

If the property is not supported or can not be set

IllegalArgumentException:

If string with the property name is null