LixM ME 1.3(1.3.0)

org.lixm.optional.v10.atattch.impl.nojsr172.helper
クラス MXParser

java.lang.Object
  上位を拡張 org.lixm.optional.v10.atattch.impl.nojsr172.helper.MXParser
すべての実装されたインタフェース:
XmlPullParser

public class MXParser
extends java.lang.Object
implements XmlPullParser

Absolutely minimal implementation of XMLPULL V1 API

作成者:
Aleksander Slominski

フィールドの概要
 
インタフェース org.lixm.optional.v10.atattch.impl.nojsr172.helper.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
 
コンストラクタの概要
MXParser()
           
 
メソッドの概要
 void defineEntityReplacementText(java.lang.String entityName, java.lang.String replacementText)
          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 of the current start tag, or -1 if the current event type 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 attribute with the given 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()
          Returns the current column number, starting from 0.
 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 name)
          Unknown properties are always returned as false
 java.lang.String getInputEncoding()
          Returns the input encoding if known, null otherwise.
 int getLineNumber()
          Returns the current line number, starting from 1.
 java.lang.String getName()
          For START_TAG or END_TAG events, the (local) name of the current element is returned when namespaces are enabled.
 java.lang.String getNamespace()
          Returns the namespace URI of the current element.
 java.lang.String getNamespace(java.lang.String prefix)
          Returns the URI corresponding to the given prefix, depending on current state of the parser.
 int getNamespaceCount(int depth)
          Returns the numbers of elements in the namespace stack for the given depth.
 java.lang.String getNamespacePrefix(int pos)
          Returns the namespace prefixe for the given position in the namespace stack.
 java.lang.String getNamespaceUri(int pos)
          Returns the namespace URI for the given position in the namespace stack If the position is out of range, an exception is thrown.
 java.lang.String getPositionDescription()
          Return string describing current position of parsers as text 'STATE [seen %s...]
 java.lang.String getPrefix()
          Returns the prefix of the current element.
 java.lang.Object getProperty(java.lang.String name)
          Look up the value of a property.
 java.lang.String getText()
          Returns the text content of the current event as String.
 char[] getTextCharacters(int[] holderForStartAndLength)
          Returns the buffer that contains the text of the current event, as well as the start offset and length relevant for the current event.
 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()
          Checks whether the 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.
 int parseEndTag()
           
 int parseStartTag()
           
 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. null will match any namespace and any name.
 void setFeature(java.lang.String name, boolean state)
          Method setFeature
 void setInput(java.io.InputStream inputStream, java.lang.String inputEncoding)
          Sets the input stream the parser is going to process.
 void setInput(java.io.Reader in)
          Set the input source for parser to the given reader and resets the parser.
 void setProperty(java.lang.String name, java.lang.Object value)
          Set the value of a property.
 void skipSubTree()
          Skip sub tree that is currently porser positioned on.
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

MXParser

public MXParser()
メソッドの詳細

setFeature

public void setFeature(java.lang.String name,
                       boolean state)
                throws XmlPullParserException
Method setFeature

定義:
インタフェース XmlPullParser 内の setFeature
パラメータ:
name - a String
state - a boolean
例外:
XmlPullParserException

getFeature

public boolean getFeature(java.lang.String name)
Unknown properties are always returned as false

定義:
インタフェース XmlPullParser 内の getFeature
パラメータ:
name - The name of feature to be retrieved.
戻り値:
The value of the feature.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws XmlPullParserException
インタフェース XmlPullParser の記述:
Set the value of a property. The property name is any fully-qualified URI.

定義:
インタフェース XmlPullParser 内の setProperty
例外:
XmlPullParserException - If the property is not supported or can not be set

getProperty

public java.lang.Object getProperty(java.lang.String name)
インタフェース XmlPullParser の記述:
Look up the value of a property. The property name is any fully-qualified URI.

NOTE: unknown properties are always returned as null.

定義:
インタフェース XmlPullParser 内の getProperty
パラメータ:
name - The name of property to be retrieved.
戻り値:
The value of named property.

setInput

public void setInput(java.io.Reader in)
              throws XmlPullParserException
インタフェース XmlPullParser の記述:
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.

定義:
インタフェース XmlPullParser 内の setInput
例外:
XmlPullParserException

setInput

public void setInput(java.io.InputStream inputStream,
                     java.lang.String inputEncoding)
              throws XmlPullParserException
インタフェース XmlPullParser の記述:
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.

NOTE: If an input encoding string 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). If encoding detection is supported then following feature http://xmlpull.org/v1/doc/features.html#detect-encoding MUST be true amd otherwise it must be false

定義:
インタフェース XmlPullParser 内の setInput
パラメータ:
inputStream - contains a raw byte input stream of possibly unknown encoding (when inputEncoding is null).
inputEncoding - if not null it MUST be used as encoding for inputStream
例外:
XmlPullParserException

getInputEncoding

public java.lang.String getInputEncoding()
インタフェース XmlPullParser の記述:
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.

定義:
インタフェース XmlPullParser 内の getInputEncoding

defineEntityReplacementText

public void defineEntityReplacementText(java.lang.String entityName,
                                        java.lang.String replacementText)
                                 throws XmlPullParserException
インタフェース 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, 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.

Note: The given value is the literal replacement text and must not contain any other entity reference (if it contains any entity reference there will be no further replacement).

Note: The list of pre-defined entity names will always contain standard XML entities such as amp (&), lt (<), gt (>), quot ("), and apos ('). Those cannot be redefined by this method!

定義:
インタフェース XmlPullParser 内の defineEntityReplacementText
例外:
XmlPullParserException
関連項目:
XmlPullParser.setInput(java.io.Reader), XmlPullParser.FEATURE_PROCESS_DOCDECL, XmlPullParser.FEATURE_VALIDATION

getNamespaceCount

public int getNamespaceCount(int depth)
                      throws XmlPullParserException
インタフェース XmlPullParser の記述:
Returns the numbers of elements in the namespace stack for the given depth. If namespaces are not enabled, 0 is returned.

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.

NOTE: to retrieve lsit of namespaces declared in current element:

       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);
           // ...
      }
 

定義:
インタフェース XmlPullParser 内の getNamespaceCount
例外:
XmlPullParserException
関連項目:
XmlPullParser.getNamespacePrefix(int), XmlPullParser.getNamespaceUri(int), XmlPullParser.getNamespace(), XmlPullParser.getNamespace(String)

getNamespacePrefix

public java.lang.String getNamespacePrefix(int pos)
                                    throws XmlPullParserException
インタフェース XmlPullParser の記述:
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.

Please note: when the parser is on an END_TAG, namespace prefixes that were declared in the corresponding START_TAG are still accessible although they are no longer in scope.

定義:
インタフェース XmlPullParser 内の getNamespacePrefix
例外:
XmlPullParserException

getNamespaceUri

public java.lang.String getNamespaceUri(int pos)
                                 throws XmlPullParserException
インタフェース XmlPullParser の記述:
Returns the namespace URI for the given position in the namespace stack If the position is out of range, an exception is thrown.

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

定義:
インタフェース XmlPullParser 内の getNamespaceUri
例外:
XmlPullParserException

getNamespace

public java.lang.String getNamespace(java.lang.String prefix)
インタフェース XmlPullParser の記述:
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;
 

Please note: parser implementations may provide more efifcient lookup, e.g. using a Hashtable. The 'xml' prefix is bound to "http://www.w3.org/XML/1998/namespace", as defined in the Namespaces in XML specification. Analogous, the 'xmlns' prefix is resolved to http://www.w3.org/2000/xmlns/

定義:
インタフェース XmlPullParser 内の getNamespace
関連項目:
XmlPullParser.getNamespaceCount(int), XmlPullParser.getNamespacePrefix(int), XmlPullParser.getNamespaceUri(int)

getDepth

public int getDepth()
インタフェース 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
 

定義:
インタフェース XmlPullParser 内の getDepth

getPositionDescription

public java.lang.String getPositionDescription()
Return string describing current position of parsers as text 'STATE [seen %s...] @line:column'.

定義:
インタフェース XmlPullParser 内の getPositionDescription

getLineNumber

public int getLineNumber()
インタフェース XmlPullParser の記述:
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).

定義:
インタフェース XmlPullParser 内の getLineNumber
戻り値:
current line number or -1 if unknown.

getColumnNumber

public int getColumnNumber()
インタフェース XmlPullParser の記述:
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).

定義:
インタフェース XmlPullParser 内の getColumnNumber
戻り値:
current column number or -1 if unknown.

isWhitespace

public boolean isWhitespace()
                     throws XmlPullParserException
インタフェース XmlPullParser の記述:
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.

Please 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.

定義:
インタフェース XmlPullParser 内の isWhitespace
例外:
XmlPullParserException

getText

public java.lang.String getText()
インタフェース XmlPullParser の記述:
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.

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

定義:
インタフェース XmlPullParser 内の getText
関連項目:
XmlPullParser.getEventType(), XmlPullParser.next(), XmlPullParser.nextToken()

getTextCharacters

public char[] getTextCharacters(int[] holderForStartAndLength)
インタフェース XmlPullParser の記述:
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.

Please note: this buffer must not be modified and its content MAY change after a call to next() or nextToken(). This method will always return the same value as getText(), except for ENTITY_REF. In the case of ENTITY ref, getText() returns the replacement text and this method returns the actual input buffer containing the entity name. If getText() returns null, this method returns null as well and the values returned in the holder array MUST be -1 (both start and length).

定義:
インタフェース XmlPullParser 内の getTextCharacters
パラメータ:
holderForStartAndLength - Must hold an 2-element int array into which the start offset and length values will be written.
戻り値:
char buffer that contains the text of the current event (null if the current event has no text associated).
関連項目:
XmlPullParser.getText(), XmlPullParser.next(), XmlPullParser.nextToken()

getNamespace

public java.lang.String getNamespace()
インタフェース XmlPullParser の記述:
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.

定義:
インタフェース XmlPullParser 内の getNamespace

getName

public java.lang.String getName()
インタフェース XmlPullParser の記述:
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.

Please note: To reconstruct the raw element name when namespaces are enabled and the prefix is not null, you will need to add the prefix and a colon to localName..

定義:
インタフェース XmlPullParser 内の getName

getPrefix

public java.lang.String getPrefix()
インタフェース XmlPullParser の記述:
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.

定義:
インタフェース XmlPullParser 内の getPrefix

isEmptyElementTag

public boolean isEmptyElementTag()
                          throws XmlPullParserException
インタフェース XmlPullParser の記述:
Returns true if the current event is START_TAG and the tag is degenerated (e.g. <foobar/>).

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

定義:
インタフェース XmlPullParser 内の isEmptyElementTag
例外:
XmlPullParserException

getAttributeCount

public int getAttributeCount()
インタフェース XmlPullParser の記述:
Returns the number of attributes of the current start tag, or -1 if the current event type is not START_TAG

定義:
インタフェース XmlPullParser 内の getAttributeCount
関連項目:
XmlPullParser.getAttributeNamespace(int), XmlPullParser.getAttributeName(int), XmlPullParser.getAttributePrefix(int), XmlPullParser.getAttributeValue(int)

getAttributeNamespace

public java.lang.String getAttributeNamespace(int index)
インタフェース XmlPullParser の記述:
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.

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".

定義:
インタフェース XmlPullParser 内の getAttributeNamespace
戻り値:
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)
インタフェース 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.

定義:
インタフェース XmlPullParser 内の getAttributeName
戻り値:
attribute name (null is never returned)

getAttributePrefix

public java.lang.String getAttributePrefix(int index)
インタフェース 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.

定義:
インタフェース XmlPullParser 内の getAttributePrefix
戻り値:
attribute prefix or null if namespaces processing is not enabled.

getAttributeType

public java.lang.String getAttributeType(int index)
インタフェース XmlPullParser の記述:
Returns the type of the specified attribute If parser is non-validating it MUST return CDATA.

定義:
インタフェース XmlPullParser 内の getAttributeType
戻り値:
attribute type (null is never returned)

isAttributeDefault

public boolean isAttributeDefault(int index)
インタフェース 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:

定義:
インタフェース XmlPullParser 内の isAttributeDefault
戻り値:
false if attribute was in input

getAttributeValue

public java.lang.String getAttributeValue(int index)
インタフェース 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

定義:
インタフェース XmlPullParser 内の getAttributeValue
戻り値:
value of attribute (null is never returned)
関連項目:
XmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String namespace,
                                          java.lang.String name)
インタフェース 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

定義:
インタフェース XmlPullParser 内の getAttributeValue
パラメータ:
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
戻り値:
value of attribute or null if attribute with given name does not exist
関連項目:
XmlPullParser.defineEntityReplacementText(java.lang.String, java.lang.String)

getEventType

public int getEventType()
                 throws XmlPullParserException
インタフェース XmlPullParser の記述:
Returns the type of the current event (START_TAG, END_TAG, TEXT, etc.)

定義:
インタフェース XmlPullParser 内の getEventType
例外:
XmlPullParserException
関連項目:
XmlPullParser.next(), XmlPullParser.nextToken()

require

public void require(int type,
                    java.lang.String namespace,
                    java.lang.String name)
             throws XmlPullParserException,
                    java.io.IOException
インタフェース 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());
 

定義:
インタフェース XmlPullParser 内の require
例外:
XmlPullParserException
java.io.IOException

skipSubTree

public void skipSubTree()
                 throws XmlPullParserException,
                        java.io.IOException
Skip sub tree that is currently porser positioned on.
NOTE: parser must be on START_TAG and when funtion returns parser will be positioned on corresponding END_TAG

例外:
XmlPullParserException
java.io.IOException

nextText

public java.lang.String nextText()
                          throws XmlPullParserException,
                                 java.io.IOException
インタフェース 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);
      }
     

    定義:
    インタフェース XmlPullParser 内の nextText
    例外:
    XmlPullParserException
    java.io.IOException

nextTag

public int nextTag()
            throws XmlPullParserException,
                   java.io.IOException
インタフェース 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;
 

定義:
インタフェース XmlPullParser 内の nextTag
例外:
XmlPullParserException
java.io.IOException

next

public int next()
         throws XmlPullParserException,
                java.io.IOException
インタフェース 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 ())

定義:
インタフェース XmlPullParser 内の next
例外:
XmlPullParserException
java.io.IOException
関連項目:
XmlPullParser.isEmptyElementTag(), XmlPullParser.START_TAG, XmlPullParser.TEXT, XmlPullParser.END_TAG, XmlPullParser.END_DOCUMENT

nextToken

public int nextToken()
              throws XmlPullParserException,
                     java.io.IOException
インタフェース 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 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)

NOTE: there is no gurantee that there will only one TEXT or IGNORABLE_WHITESPACE event from nextToken() as parser may chose to deliver element content in multiple tokens (dividing element content into chunks)

NOTE: whether returned text of token is end-of-line normalized is depending on FEATURE_XML_ROUNDTRIP.

NOTE: XMLDecl (<?xml ...?>) is not reported but its content is available through optional properties (see class description above).

定義:
インタフェース XmlPullParser 内の nextToken
例外:
XmlPullParserException
java.io.IOException
関連項目:
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

parseEndTag

public int parseEndTag()
                throws XmlPullParserException,
                       java.io.IOException
例外:
XmlPullParserException
java.io.IOException

parseStartTag

public int parseStartTag()
                  throws XmlPullParserException,
                         java.io.IOException
例外:
XmlPullParserException
java.io.IOException

LixM ME 1.3(1.3.0)

Copyright © 2005-2008 tasogare. All rights reserved.