- /*
- * The Apache Software License, Version 1.1
- *
- *
- * Copyright (c) 2001, 2002 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Xerces" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation and was
- * originally based on software copyright (c) 1999, International
- * Business Machines, Inc., http://www.apache.org. For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
-
- package com.sun.org.apache.xerces.internal.xni.parser;
-
- import java.io.IOException;
-
- import com.sun.org.apache.xerces.internal.xni.XNIException;
-
- /**
- * Represents a parser configuration that can be used as the
- * configuration for a "pull" parser. A pull parser allows the
- * application to drive the parser instead of having document
- * information events "pushed" to the registered handlers.
- * <p>
- * A pull parser using this type of configuration first calls
- * the <code>setInputSource</code> method. After the input
- * source is set, the pull parser repeatedly calls the
- * <code>parse(boolean):boolean</code> method. This method
- * returns a value of true if there is more to parse in the
- * document.
- * <p>
- * Calling the <code>parse(XMLInputSource)</code> is equivalent
- * to setting the input source and calling the
- * <code>parse(boolean):boolean</code> method with a "complete"
- * value of <code>true</code>.
- *
- * @author Andy Clark, IBM
- *
- * @version $Id: XMLPullParserConfiguration.java,v 1.5 2002/11/19 01:41:38 twl Exp $
- */
- public interface XMLPullParserConfiguration
- extends XMLParserConfiguration {
-
- //
- // XMLPullParserConfiguration methods
- //
-
- // parsing
-
- /**
- * Sets the input source for the document to parse.
- *
- * @param inputSource The document's input source.
- *
- * @exception XMLConfigurationException Thrown if there is a
- * configuration error when initializing the
- * parser.
- * @exception IOException Thrown on I/O error.
- *
- * @see #parse(boolean)
- */
- public void setInputSource(XMLInputSource inputSource)
- throws XMLConfigurationException, IOException;
-
- /**
- * Parses the document in a pull parsing fashion.
- *
- * @param complete True if the pull parser should parse the
- * remaining document completely.
- *
- * @return True if there is more document to parse.
- *
- * @exception XNIException Any XNI exception, possibly wrapping
- * another exception.
- * @exception IOException An IO exception from the parser, possibly
- * from a byte stream or character stream
- * supplied by the parser.
- *
- * @see #setInputSource
- */
- public boolean parse(boolean complete) throws XNIException, IOException;
-
- /**
- * If the application decides to terminate parsing before the xml document
- * is fully parsed, the application should call this method to free any
- * resource allocated during parsing. For example, close all opened streams.
- */
- public void cleanup();
-
- } // interface XMLPullParserConfiguration