org.apache.xerces.xni.parser

Interface XMLPullParserConfiguration

public interface XMLPullParserConfiguration extends XMLParserConfiguration

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.

A pull parser using this type of configuration first calls the setInputSource method. After the input source is set, the pull parser repeatedly calls the parse(boolean):boolean method. This method returns a value of true if there is more to parse in the document.

Calling the parse(XMLInputSource) is equivalent to setting the input source and calling the parse(boolean):boolean method with a "complete" value of true.

Version: $Id: XMLPullParserConfiguration.java,v 1.6 2004/02/24 23:15:56 mrglavas Exp $

Author: Andy Clark, IBM

Method Summary
voidcleanup()
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.
booleanparse(boolean complete)
Parses the document in a pull parsing fashion.
voidsetInputSource(XMLInputSource inputSource)
Sets the input source for the document to parse.

Method Detail

cleanup

public void cleanup()
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.

parse

public boolean parse(boolean complete)
Parses the document in a pull parsing fashion.

Parameters: complete True if the pull parser should parse the remaining document completely.

Returns: True if there is more document to parse.

Throws: XNIException Any XNI exception, possibly wrapping another exception. IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the parser.

See Also: XMLPullParserConfiguration

setInputSource

public void setInputSource(XMLInputSource inputSource)
Sets the input source for the document to parse.

Parameters: inputSource The document's input source.

Throws: XMLConfigurationException Thrown if there is a configuration error when initializing the parser. IOException Thrown on I/O error.

See Also: XMLPullParserConfiguration

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.