パッケージ org.xmlpull.v1.wrapper.classic

クラス XmlPullParserDelegate

  • すべての実装されたインタフェース:
    XmlPullParser
    直系の既知のサブクラス:
    StaticXmlPullParserWrapper
    public class XmlPullParserDelegate
extends Object
implements XmlPullParser
    This is simple class that implements parser interface by delegating all calls to actual wrapped class implementation that is passed in constructor. Purpose of this class is to work as a base class when extending parser interface by wrapping exsiting parser implementation and allowing to add new methods.
    作成者:
    Aleksander Slominski

    • コンストラクタの詳細

      • XmlPullParserDelegate

        public XmlPullParserDelegate​(XmlPullParser pp)

    • メソッドの詳細

      • getText

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

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

      • setFeature

        public void setFeature​(String name,
                       boolean state)
                throws XmlPullParserException
        インタフェースからコピーされた説明: 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 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.

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

      • 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).

        定義:
        getTextCharacters インタフェース内 XmlPullParser
        パラメータ:
        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()

      • 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).
        定義:
        getColumnNumber インタフェース内 XmlPullParser
        戻り値:
        current column number or -1 if unknown.

      • getNamespacePrefix

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

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

      • getAttributeName

        public 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.
        定義:
        getAttributeName インタフェース内 XmlPullParser
        戻り値:
        attribute name (null is never returned)

      • getName

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

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

      • getFeature

        public boolean getFeature​(String name)
        インタフェースからコピーされた説明: XmlPullParser
        Returns the current value of the given feature.

        Please note: unknown features are always returned as false.

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

      • getInputEncoding

        public 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.
        定義:
        getInputEncoding インタフェース内 XmlPullParser

      • getNamespace

        public String getNamespace​(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/

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

      • setInput

        public void setInput​(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.
        定義:
        setInput インタフェース内 XmlPullParser
        例外:
        XmlPullParserException

      • 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).
        定義:
        getLineNumber インタフェース内 XmlPullParser
        戻り値:
        current line number or -1 if unknown.

      • getProperty

        public Object getProperty​(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.

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

      • 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:
        定義:
        isAttributeDefault インタフェース内 XmlPullParser
        戻り値:
        false if attribute was in input

      • getNamespaceUri

        public 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

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

      • nextToken

        public int nextToken()
              throws XmlPullParserException,
                     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).

        定義:
        nextToken インタフェース内 XmlPullParser
        例外:
        XmlPullParserException
        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

      • defineEntityReplacementText

        public void defineEntityReplacementText​(String entityName,
                                        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 &lt;, ampersnad with &amp; 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 (&amp;), lt (&lt;), gt (&gt;), quot (&quot;), and apos (&apos;). Those cannot be redefined by this method!

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

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

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

      • getPrefix

        public 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.
        定義:
        getPrefix インタフェース内 XmlPullParser

      • require

        public void require​(int type,
                    String namespace,
                    String name)
             throws XmlPullParserException,
                    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());
        定義:
        require インタフェース内 XmlPullParser
        例外:
        XmlPullParserException
        IOException

      • nextText

        public String nextText()
                throws XmlPullParserException,
                       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);
  }
        定義:
        nextText インタフェース内 XmlPullParser
        例外:
        XmlPullParserException
        IOException

      • getAttributeType

        public String getAttributeType​(int index)
        インタフェースからコピーされた説明: XmlPullParser
        Returns the type of the specified attribute If parser is non-validating it MUST return CDATA.
        定義:
        getAttributeType インタフェース内 XmlPullParser
        戻り値:
        attribute type (null is never returned)

      • 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
        定義:
        getDepth インタフェース内 XmlPullParser

      • nextTag

        public int nextTag()
            throws XmlPullParserException,
                   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;
        定義:
        nextTag インタフェース内 XmlPullParser
        例外:
        XmlPullParserException
        IOException

      • getAttributePrefix

        public 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.
        定義:
        getAttributePrefix インタフェース内 XmlPullParser
        戻り値:
        attribute prefix or null if namespaces processing is not enabled.

      • setInput

        public void setInput​(InputStream inputStream,
                     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

        定義:
        setInput インタフェース内 XmlPullParser
        パラメータ:
        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

      • getAttributeValue

        public String getAttributeValue​(String namespace,
                                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

        定義:
        getAttributeValue インタフェース内 XmlPullParser
        パラメータ:
        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)

      • getPositionDescription

        public String getPositionDescription()
        インタフェースからコピーされた説明: XmlPullParser
        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.
        定義:
        getPositionDescription インタフェース内 XmlPullParser

      • getNamespace

        public 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.
        定義:
        getNamespace インタフェース内 XmlPullParser

      • getAttributeNamespace

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

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