Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.kxml2.io
Class KXmlParser

java.lang.Object
  extended byorg.kxml2.io.KXmlParser
All Implemented Interfaces:
XmlPullParser
public class KXmlParser
extends java.lang.Object
implements XmlPullParser

A simple, pull based XML parser. This classe replaces the XmlParser class and the corresponding event classes.

Field Summary
 
Fields inherited from interface org.xmlpull.v1.XmlPullParser
CDSECT, COMMENT, DOCDECL, END_DOCUMENT, END_TAG, ENTITY_REF, FEATURE_PROCESS_DOCDECL, FEATURE_PROCESS_NAMESPACES, FEATURE_REPORT_NAMESPACE_ATTRIBUTES, FEATURE_VALIDATION, IGNORABLE_WHITESPACE, NO_NAMESPACE, PROCESSING_INSTRUCTION, START_DOCUMENT, START_TAG, TEXT, TYPES
 
Constructor Summary
KXmlParser()
           
KXmlParser(int sz)
           
 
Method Summary
 void defineEntityReplacementText(java.lang.String entity, java.lang.String value)
          Set new value for entity replacement text as defined in XML 1.0 Section 4.5 Construction of Internal Entity Replacement Text.
 int getAttributeCount()
          Returns the number of attributes on the current element; -1 if the current event is not START_TAG
 java.lang.String getAttributeName(int index)
          Returns the local name of the specified attribute if namespaces are enabled or just attribute name if namespaces are disabled.
 java.lang.String getAttributeNamespace(int index)
          Returns the namespace URI of the specified attribute number index (starts from 0).
 java.lang.String getAttributePrefix(int index)
          Returns the prefix of the specified attribute Returns null if the element has no prefix.
 java.lang.String getAttributeType(int index)
          Returns the type of the specified attribute If parser is non-validating it MUST return CDATA.
 java.lang.String getAttributeValue(int index)
          Returns the given attributes value.
 java.lang.String getAttributeValue(java.lang.String namespace, java.lang.String name)
          Returns the attributes value identified by namespace URI and namespace localName.
 int getColumnNumber()
          Current column: numbering starts from 0 (zero should be returned when parser is in START_DOCUMENT state!) It must return -1 if parser does not know current line number or can not determine it (for example in case of WBXML)
 int getDepth()
          Returns the current depth of the element.
 int getEventType()
          Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)
 boolean getFeature(java.lang.String feature)
          Return the current value of the feature with given name.
 java.lang.String getInputEncoding()
          Return input encoding if known or null if unknown.
 int getLineNumber()
          Current line number: numebering starts from 1.
 java.lang.String getName()
          For START_TAG or END_TAG returns the (local) name of the current element when namespaces are enabled or raw name when namespaces are disabled.
 java.lang.String getNamespace()
          Returns the namespace URI of the current element (default namespace is represented as empty string).
 java.lang.String getNamespace(java.lang.String prefix)
          Return uri for the given prefix.
 int getNamespaceCount(int depth)
          Return position in stack of first namespace slot for element at passed depth.
 java.lang.String getNamespacePrefix(int pos)
          Return namespace prefixes for position pos in namespace stack If pos is out of range it throw exception.
 java.lang.String getNamespaceUri(int pos)
          Return namespace URIs for position pos in namespace stack If pos is out of range it throw exception.
 java.lang.String getPositionDescription()
          Short text describing parser position, including a description of the current event and data source if known and if possible what parser was seeing lastly in input.
 java.lang.String getPrefix()
          Returns the prefix of the current element or null if elemet has no prefix (is in defualt namespace).
 java.lang.Object getProperty(java.lang.String property)
          Look up the value of a property.
 java.lang.String getText()
          Read text content of the current event as String.
 char[] getTextCharacters(int[] poslen)
          Get the buffer that contains text of the current event and start offset of text is passed in first slot of input int array and its length is in second slot.
 boolean isAttributeDefault(int index)
          Returns if the specified attribute was not in input was declared in XML.
 boolean isEmptyElementTag()
          Returns true if the current event is START_TAG and the tag is degenerated (e.g.
 boolean isWhitespace()
          Check if current TEXT event contains only whitespace characters.
 int next()
          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).
 int nextTag()
          Call next() and return event if it is START_TAG or END_TAG otherwise throw an exception.
 java.lang.String nextText()
          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.
 int nextToken()
          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.
 void require(int type, java.lang.String namespace, java.lang.String name)
          Test if the current event is of the given type and if the namespace and name do match.
 void setFeature(java.lang.String feature, boolean value)
          Use this call to change the general behaviour of the parser, such as namespace processing or doctype declaration handling.
 void setInput(java.io.InputStream is, java.lang.String enc)
          Set the input stream for parser.
 void setInput(java.io.Reader reader)
          Set the input for parser.
 void setProperty(java.lang.String property, java.lang.Object value)
          Set the value of a property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KXmlParser

public KXmlParser()

KXmlParser

public KXmlParser(int sz)
Method Detail

setInput

public void setInput(java.io.Reader reader)
              throws XmlPullParserException
Description copied from interface: XmlPullParser
Set the input for parser. Parser event state is set to START_DOCUMENT. Using null parameter will stop parsing and reset parser state allowing parser to free internal resources (such as parsing buffers). No character will be read from input reader until first call to one of next() methods.

Specified by:
setInput in interface XmlPullParser
Throws:
XmlPullParserException

setInput

public void setInput(java.io.InputStream is,
                     java.lang.String enc)
              throws XmlPullParserException
Description copied from interface: XmlPullParser
Set the input stream for parser. Parser event state is set to START_DOCUMENT. This call will stop parsing and reset parser state.

NOTE: calling this function will not result in reading any input bytes even when parser have to determine input encoding including byte order marks and detection <? xml encoding (in case when inputEncoding is null). The XMLPULL implementation MUST postpone reading of input bytes until first call to one of next() methods.

NOTE: if inputEncoding is passed it MUST be used otherwise if inputEncoding is null the parser SHOULD try to determine input encoding following XML 1.0 specification (see below) but it is not required (for example when parser is constrained by memory footprint such as in J2ME environments) If encoding detection is supported then following feature http://xmlpull.org/v1/doc/features.html#detect-encoding MUST be true otherwise it must be false

Specified by:
setInput in interface XmlPullParser
Parameters:
is - contains raw byte input stream of possibly unknown encoding (when inputEncoding is null) and in such case the parser must derive encoding from <?xml declaration or assume UTF8 or UTF16 as described in XML 1.0 Appendix F.1 Detection Without External Encoding Information otherwise if inputEncoding is present then it must be used (this is consistent with XML 1.0 Appendix F.2 Priorities in the Presence of External Encoding Information that allows for exception only for files and in such cases inputEncoding should be null to trigger autodetecting. if inputStream is null the IllegalArgumentException must be thrown
enc - if not null it MUST be used as encoding for inputStream
Throws:
XmlPullParserException

getFeature

public boolean getFeature(java.lang.String feature)
Description copied from interface: XmlPullParser
Return the current value of the feature with given name.

NOTE: unknown features are always returned as false

Specified by:
getFeature in interface XmlPullParser
Parameters:
feature - The name of feature to be retrieved.
Returns:
The value of named feature.

getInputEncoding

public java.lang.String getInputEncoding()
Description copied from interface: XmlPullParser
Return input encoding if known or null if unknown. If setInput(InputStream, inputEncoding) was called with not null inpuEncoding it must be returned by this function. Otherwise if inputEncoding is null and parser suppports feature http://xmlpull.org/v1/doc/features.html#detect-encoding then it must return detected encoding. If setInput(Reader) was called returned encoding name is null.

Specified by:
getInputEncoding in interface XmlPullParser

defineEntityReplacementText

public void defineEntityReplacementText(java.lang.String entity,
                                        java.lang.String value)
                                 throws XmlPullParserException
Description copied from interface: XmlPullParser
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 then calling this function will reulst in exception because when processing of DOCDECL is enabled there is no need to set manually entity replacement text.

The motivation for this function is to allow very small implementations of XMLPULL that will work in J2ME environments and though may not be able to process DOCDECL but still can be made to work with predefined DTDs by using this function to define well known in advance entities. Additionally as XML Schemas are replacing DTDs by allowing parsers not to process DTDs it is possible to create more efficient parser implementations that can be used as underlying layer to do XML schemas validation.

NOTE: this is replacement text and it is not allowed to contain any other entity reference

NOTE: list of pre-defined entites will always contain standard XML entities (such as &amp; &lt; &gt; &quot; &apos;) and they cannot be replaced!

Specified by:
defineEntityReplacementText in interface XmlPullParser
Throws:
XmlPullParserException
See Also:
XmlPullParser.setInput(java.io.Reader), XmlPullParser.FEATURE_PROCESS_DOCDECL, XmlPullParser.FEATURE_VALIDATION

getProperty

public java.lang.Object getProperty(java.lang.String property)
Description copied from interface: XmlPullParser
Look up the value of a property. The property name is any fully-qualified URI. I

NOTE: unknown features are always returned as null

Specified by:
getProperty in interface XmlPullParser
Parameters:
property - The name of property to be retrieved.
Returns:
The value of named property.

getNamespaceCount

public int getNamespaceCount(int depth)
Description copied from interface: XmlPullParser
Return position in stack of first namespace slot for element at passed depth. If namespaces are not enabled it returns always 0.

NOTE: default namespace is included in namespace table and is available by using null string as in getNamespace(null) (it may return null if xmlns="..." is not present) and as well by calling getNamespace() (that will never return null but "").

NOTE: when parser is on END_TAG then it is allowed to call this function with getDepth()+1 argument to retrieve position of namespace prefixes and URIs that were declared on corresponding START_TAG.

Specified by:
getNamespaceCount in interface XmlPullParser
See Also:
XmlPullParser.getNamespacePrefix(int), XmlPullParser.getNamespaceUri(int), XmlPullParser.getNamespace(), XmlPullParser.getNamespace(String)

getNamespacePrefix

public java.lang.String getNamespacePrefix(int pos)
Description copied from interface: XmlPullParser
Return namespace prefixes for position pos in namespace stack If pos is out of range it throw exception.

NOTE: when parser is on END_TAG then namespace prefixes that were declared in corresponding START_TAG are still accessible even though they are not in scope.

Specified by:
getNamespacePrefix in interface XmlPullParser

getNamespaceUri

public java.lang.String getNamespaceUri(int pos)
Description copied from interface: XmlPullParser
Return namespace URIs for position pos in namespace stack If pos is out of range it throw exception.

NOTE: when parser is on END_TAG then namespace prefixes that were declared in corresponding START_TAG are still accessible even though they are not in scope

Specified by:
getNamespaceUri in interface XmlPullParser

getNamespace

public java.lang.String getNamespace(java.lang.String prefix)
Description copied from interface: XmlPullParser
Return uri for the given prefix. It is depending on current state of parser to find what namespace uri is mapped from namespace prefix. For example for 'xsi' if xsi namespace prefix was declared to 'urn:foo' it will return 'urn:foo'.

It will return null if namespace could not be found.

Convenience method for 

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

NOTE: parser implementation can do more efifcient lookup (using Hashtable for exmaple).

NOTE:The 'xml' prefix is bound as defined in Namespaces in XML specification to "http://www.w3.org/XML/1998/namespace".

NOTE: The 'xmlns' prefix must be resolved to following namespace http://www.w3.org/2000/xmlns/ (visit this URL for description!).

Specified by:
getNamespace in interface XmlPullParser
See Also:
XmlPullParser.getNamespaceCount(int), XmlPullParser.getNamespacePrefix(int), XmlPullParser.getNamespaceUri(int)

getDepth

public int getDepth()
Description copied from interface: XmlPullParser
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
 </pre>

Specified by:
getDepth in interface XmlPullParser

getPositionDescription

public java.lang.String getPositionDescription()
Description copied from interface: XmlPullParser
Short text describing parser position, including a description of the current event and data source if known and if possible what parser was seeing lastly in input. This method is especially useful to give more meaningful error messages.

Specified by:
getPositionDescription in interface XmlPullParser

getLineNumber

public int getLineNumber()
Description copied from interface: XmlPullParser
Current line number: numebering starts from 1. It must return -1 if parser does not know current line number or can not determine it (for example in case of WBXML)

Specified by:
getLineNumber in interface XmlPullParser
Returns:
current column number or -1 of unknown

getColumnNumber

public int getColumnNumber()
Description copied from interface: XmlPullParser
Current column: numbering starts from 0 (zero should be returned when parser is in START_DOCUMENT state!) It must return -1 if parser does not know current line number or can not determine it (for example in case of WBXML)

Specified by:
getColumnNumber in interface XmlPullParser
Returns:
current column number or -1 of unknown

isWhitespace

public boolean isWhitespace()
                     throws XmlPullParserException
Description copied from interface: XmlPullParser
Check if current TEXT event contains only whitespace characters. For IGNORABLE_WHITESPACE, this is always true. For TEXT and CDSECT if the current event text contains at lease one non white space character then false is returned. For any other event type exception is thrown.

NOTE: non-validating parsers are not able to distinguish whitespace and ignorable whitespace except from whitespace outside the root element. ignorable whitespace is reported as separate event which is exposed via nextToken only.

NOTE: this function can be only called for element content related events (TEXT, CDSECT or IGNORABLE_WHITESPACE) otherwise exception will be thrown!

Specified by:
isWhitespace in interface XmlPullParser
Throws:
XmlPullParserException

getText

public java.lang.String getText()
Description copied from interface: XmlPullParser
Read text content of the current event as String.

NOTE: in case of ENTITY_REF this method returns entity replacement text (or null if not available) and it is the only case when getText() and getTextCharacters() returns different values.

Specified by:
getText in interface XmlPullParser

getTextCharacters

public char[] getTextCharacters(int[] poslen)
Description copied from interface: XmlPullParser
Get the buffer that contains text of the current event and start offset of text is passed in first slot of input int array and its length is in second slot.

NOTE: this buffer must not be modified and its content MAY change after call to next() or nextToken().

NOTE: this method must return always the same value as getText() except in case of ENTITY_REF (where getText() is replacement text and this method returns actual input buffer with entity name the same as getName()). If getText() returns null then this method returns null as well and values returned in holder MUST be -1 (both start and length).

Specified by:
getTextCharacters in interface XmlPullParser
Parameters:
poslen - the 2-element int array into which values of start offset and length will be written into frist and second slot of array.
Returns:
char buffer that contains text of current event or null if the current event has no text associated.
See Also:
XmlPullParser.getText()

getNamespace

public java.lang.String getNamespace()
Description copied from interface: XmlPullParser
Returns the namespace URI of the current element (default namespace is represented as empty string). If namespaces are NOT enabled, an empty String ("") always is returned. The current event must be START_TAG or END_TAG, otherwise, null is returned.

Specified by:
getNamespace in interface XmlPullParser

getName

public java.lang.String getName()
Description copied from interface: XmlPullParser
For START_TAG or END_TAG returns the (local) name of the current element when namespaces are enabled or raw name when namespaces are disabled. For ENTITY_REF it returns entity name. The current event must be START_TAG or END_TAG or ENTITY_REF, otherwise null is returned.

NOTE: to reconstruct raw element name when namespaces are enabled you will need to add prefix and colon to localName if prefix is not null.

Specified by:
getName in interface XmlPullParser

getPrefix

public java.lang.String getPrefix()
Description copied from interface: XmlPullParser
Returns the prefix of the current element or null if elemet has no prefix (is in defualt namespace). If namespaces are not enabled it always returns null. If the current event is not START_TAG or END_TAG the null value is returned.

Specified by:
getPrefix in interface XmlPullParser

isEmptyElementTag

public boolean isEmptyElementTag()
                          throws XmlPullParserException
Description copied from interface: XmlPullParser
Returns true if the current event is START_TAG and the tag is degenerated (e.g. <foobar/>).

NOTE: if parser is not on START_TAG then the exception will be thrown.

Specified by:
isEmptyElementTag in interface XmlPullParser
Throws:
XmlPullParserException

getAttributeCount

public int getAttributeCount()
Description copied from interface: XmlPullParser
Returns the number of attributes on the current element; -1 if the current event is not START_TAG

Specified by:
getAttributeCount in interface XmlPullParser
See Also:
XmlPullParser.getAttributeNamespace(int), XmlPullParser.getAttributeName(int), XmlPullParser.getAttributePrefix(int), XmlPullParser.getAttributeValue(int)

getAttributeType

public java.lang.String getAttributeType(int index)
Description copied from interface: XmlPullParser
Returns the type of the specified attribute If parser is non-validating it MUST return CDATA.

Specified by:
getAttributeType in interface XmlPullParser
Returns:
attribute type (null is never returned)

isAttributeDefault

public boolean isAttributeDefault(int index)
Description copied from interface: XmlPullParser
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:

Specified by:
isAttributeDefault in interface XmlPullParser
Returns:
false if attribute was in input

getAttributeNamespace

public java.lang.String getAttributeNamespace(int index)
Description copied from interface: XmlPullParser
Returns the namespace URI of the specified attribute number index (starts from 0). Returns empty string ("") if namespaces are not enabled or attribute has no namespace. Throws an IndexOutOfBoundsException if the index is out of range or current event type is not START_TAG.

NOTE: if FEATURE_REPORT_NAMESPACE_ATTRIBUTES is set then namespace attributes (xmlns:ns='...') must be reported with namespace http://www.w3.org/2000/xmlns/ (visit this URL for description!). The default namespace attribute (xmlns="...") will be reported with empty namespace.

NOTE:The xml prefix is bound as defined in Namespaces in XML specification to "http://www.w3.org/XML/1998/namespace".

Specified by:
getAttributeNamespace in interface XmlPullParser
Returns:
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).

getAttributeName

public java.lang.String getAttributeName(int index)
Description copied from interface: XmlPullParser
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.

Specified by:
getAttributeName in interface XmlPullParser
Returns:
attribute name (null is never returned)

getAttributePrefix

public java.lang.String getAttributePrefix(int index)
Description copied from interface: XmlPullParser
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.

Specified by:
getAttributePrefix in interface XmlPullParser
Returns:
attribute prefix or null if namespaces processing is not enabled.

getAttributeValue

public java.lang.String getAttributeValue(int index)
Description copied from interface: XmlPullParser
Returns the given attributes value. Throws an IndexOutOfBoundsException if the index is out of range or current event type is not START_TAG.

NOTE: attribute value must be normalized (including entity replacement text if PROCESS_DOCDECL is false) as described in XML 1.0 section 3.3.3 Attribute-Value Normalization

Specified by:
getAttributeValue in interface XmlPullParser
Returns:
value of attribute (null is never returned)
See Also:
XmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String namespace,
                                          java.lang.String name)
Description copied from interface: XmlPullParser
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.

NOTE: attribute value must be normalized (including entity replacement text if PROCESS_DOCDECL is false) as described in XML 1.0 section 3.3.3 Attribute-Value Normalization

Specified by:
getAttributeValue in interface XmlPullParser
Parameters:
namespace - Namespace of the attribute if namespaces are enabled otherwise must be null
name - If namespaces enabled local name of attribute otherwise just attribute name
Returns:
value of attribute or null if attribute with given name does not exist
See Also:
XmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)

getEventType

public int getEventType()
                 throws XmlPullParserException
Description copied from interface: XmlPullParser
Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)

Specified by:
getEventType in interface XmlPullParser
Throws:
XmlPullParserException
See Also:
XmlPullParser.next(), XmlPullParser.nextToken()

next

public int next()
         throws XmlPullParserException,
                java.io.IOException
Description copied from interface: XmlPullParser
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.

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

Specified by:
next in interface XmlPullParser
Throws:
XmlPullParserException
java.io.IOException
See Also:
XmlPullParser.isEmptyElementTag(), XmlPullParser.START_TAG, XmlPullParser.TEXT, XmlPullParser.END_TAG, XmlPullParser.END_DOCUMENT

nextToken

public int nextToken()
              throws XmlPullParserException,
                     java.io.IOException
Description copied from interface: XmlPullParser
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 true then it is possible to do XML document round trip ie. reproduce exectly on output the XML input using getText().

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 enabled and then returns XML tag, ex: </tag>
TEXT
return unnormalized element content
IGNORABLE_WHITESPACE
return unnormalized characters
CDSECT
return unnormalized text inside CDATA ex. 'fo<o' from <!CDATA[fo<o]]>
PROCESSING_INSTRUCTION
return unnormalized PI content ex: 'pi foo' from <?pi foo?>
COMMENT
return comment content ex. 'foo bar' from <!--foo bar-->
ENTITY_REF
return unnormalized text of entity_name (&entity_name;)
NOTE: it is user responsibility to resolve entity reference
NOTE: character entities and standard entities such as &amp; &lt; &gt; &quot; &apos; are reported as well and are not resolved and not reported as TEXT tokens but as ENTITY_REF tokens! This requirement is added to allow to do roundtrip of XML documents!
DOCDECL
return inside part of DOCDECL ex. 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">]>

NOTE: returned text of token is not end-of-line normalized.

Specified by:
nextToken in interface XmlPullParser
Throws:
XmlPullParserException
java.io.IOException
See Also:
XmlPullParser.next(), XmlPullParser.START_TAG, XmlPullParser.TEXT, XmlPullParser.END_TAG, XmlPullParser.END_DOCUMENT, XmlPullParser.COMMENT, XmlPullParser.DOCDECL, XmlPullParser.PROCESSING_INSTRUCTION, XmlPullParser.ENTITY_REF, XmlPullParser.IGNORABLE_WHITESPACE

nextTag

public int nextTag()
            throws XmlPullParserException,
                   java.io.IOException
Description copied from interface: XmlPullParser
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;

Specified by:
nextTag in interface XmlPullParser
Throws:
XmlPullParserException
java.io.IOException

require

public void require(int type,
                    java.lang.String namespace,
                    java.lang.String name)
             throws XmlPullParserException,
                    java.io.IOException
Description copied from interface: XmlPullParser
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());

Specified by:
require in interface XmlPullParser
Throws:
XmlPullParserException
java.io.IOException

nextText

public java.lang.String nextText()
                          throws XmlPullParserException,
                                 java.io.IOException
Description copied from interface: XmlPullParser
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);
  }

Specified by:
nextText in interface XmlPullParser
Throws:
XmlPullParserException
java.io.IOException

setFeature

public void setFeature(java.lang.String feature,
                       boolean value)
                throws XmlPullParserException
Description copied from interface: XmlPullParser
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 trown.

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

Specified by:
setFeature in interface XmlPullParser
Throws:
XmlPullParserException - if feature is not supported or can not be set

setProperty

public void setProperty(java.lang.String property,
                        java.lang.Object value)
                 throws XmlPullParserException
Description copied from interface: XmlPullParser
Set the value of a property. The property name is any fully-qualified URI.

Specified by:
setProperty in interface XmlPullParser
Throws:
XmlPullParserException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD