org.apache.xerces.xni.parser: public interface: XMLPullParserConfiguration

org.apache.xerces.xni.parser
public interface: XMLPullParserConfiguration [javadoc | source]

All Implemented Interfaces:
XMLParserConfiguration

All Known Implementing Classes:
XPointerParserConfiguration, SoftReferenceSymbolTableConfiguration, StandardParserConfiguration, PSVIConfiguration, XIncludeAwareParserConfiguration, NonValidatingParserConfiguration, DTDConfiguration, XML11Configuration, XML11DTDConfiguration, IntegratedParserConfiguration, XMLGrammarCachingConfiguration, SchemaParsingConfig, XML11NonValidatingConfiguration, SecurityConfiguration, NonValidatingConfiguration, XIncludeParserConfiguration

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.

author: Andy - Clark, IBM

version: $ - Id: XMLPullParserConfiguration.java 447244 2006-09-18 05:20:40Z mrglavas $

Method from org.apache.xerces.xni.parser.XMLPullParserConfiguration Summary:
cleanup, parse, setInputSource

Method from org.apache.xerces.xni.parser.XMLPullParserConfiguration Detail:
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.
public boolean parse(boolean complete) throws IOException, XNIException Parses the document in a pull parsing fashion.
public void setInputSource(XMLInputSource inputSource) throws IOException, XMLConfigurationException Sets the input source for the document to parse.

Method from org.apache.xerces.xni.parser.XMLPullParserConfiguration Detail:

 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.

 public boolean parse(boolean complete) throws IOException, XNIExceptionParses the document in a pull parsing fashion.

 public  void setInputSource(XMLInputSource inputSource) throws IOException, XMLConfigurationExceptionSets the input source for the document to parse.