XmlPullParser

package org.xmlpull.v1;

public interface XmlPullParser {

    public final static String NO_NAMESPACE = "";

    public final static int START_DOCUMENT;
    public final static int END_DOCUMENT;
    public final static int START_TAG;
    public final static int END_TAG;
    public final static int TEXT;
    public final static int CDSECT;
    public final static int ENTITY_REF;
    public final static int IGNORABLE_WHITESPACE;
    public final static int PROCESSING_INSTRUCTION;
    public final static int COMMENT;
    public final static int DOCDECL;

    public final static String [] TYPES = {
        "START_DOCUMENT",
        "END_DOCUMENT",
        "START_TAG",
        "END_TAG",
        "TEXT",
        "CDSECT",
        "ENTITY_REF",
        "IGNORABLE_WHITESPACE",
        "PROCESSING_INSTRUCTION",
        "COMMENT",
        "DOCDECL"
    };

    public final static String FEATURE_PROCESS_NAMESPACES =
        "http://xmlpull.org/v1/doc/features.html#process-namespaces";
    public final static String FEATURE_REPORT_NAMESPACE_ATTRIBUTES =
        "http://xmlpull.org/v1/doc/features.html#report-namespace-prefixes";
    public final static String FEATURE_PROCESS_DOCDECL =
        "http://xmlpull.org/v1/doc/features.html#process-docdecl";
    public final static String FEATURE_VALIDATION =
        "http://xmlpull.org/v1/doc/features.html#validation";

    public void setFeature(String name, boolean state) 
     throws XmlPullParserException;
    public boolean getFeature(String name);
    public void setProperty(String name, Object value)
     throws XmlPullParserException;
    public Object getProperty(String name);

    public void setInput(Reader in) throws XmlPullParserException;
    public void setInput(InputStream inputStream, String inputEncoding)
        throws XmlPullParserException;

    // actual parsing methods
    public int getEventType()
        throws XmlPullParserException;
    public int next()
        throws XmlPullParserException, IOException;
    public int nextToken()
        throws XmlPullParserException, IOException;
        
    // Utility methods
    public void require(int type, String namespace, String name)
        throws XmlPullParserException, IOException;
    public String nextText() throws XmlPullParserException, IOException;
    public int    nextTag() throws XmlPullParserException, IOException;        
        
    public String getInputEncoding();
    public void defineEntityReplacementText( String entityName,
     String replacementText ) throws XmlPullParserException;
    public int getNamespaceCount(int depth) 
     throws XmlPullParserException;
     
   public String getNamespacePrefix(int position) throws XmlPullParserException;
   public String getNamespaceUri(int position) throws XmlPullParserException;
   public String getNamespace(String prefix);
   public int    getDepth();
   public String getPositionDescription();
   public int    getLineNumber();
   public int    getColumnNumber();

   // Text methods
   public boolean isWhitespace() throws XmlPullParserException;
   public String  getText();
   public char[]  getTextCharacters(int[] holderForStartAndLength);

    // Tag methods
    public String  getNamespace();
    public String  getName();
    public String  getPrefix();
    public boolean isEmptyElementTag() throws XmlPullParserException;

    // Attribute methods
    public int     getAttributeCount();
    public String  getAttributeNamespace(int index);
    public String  getAttributePrefix(int index);
    public String  getAttributeType(int index);
    public boolean isAttributeDefault(int index);
    public String  getAttributeValue(int index);
    public String  getAttributeValue(String namespace, String name);
}

Previous | Next | Top | Cafe con Leche

Copyright 2000-2002 Elliotte Rusty Harold
elharo@metalab.unc.edu
Last Modified September 9, 2002