XMLPullParserConfiguration

implements XMLParserConfiguration

org.apache.xerces.xni.parser.XMLPullParserConfiguration

Known Indirect Subclasses

DTDConfiguration, IntegratedParserConfiguration, NonValidatingConfiguration, SchemaParsingConfig, SecurityConfiguration, SoftReferenceSymbolTableConfiguration, StandardParserConfiguration, XIncludeAwareParserConfiguration, XIncludeParserConfiguration, XML11Configuration, XML11DTDConfiguration, XML11NonValidatingConfiguration, XMLGrammarCachingConfiguration, XPointerParserConfiguration

DTDConfiguration	This is the DTD-only parser configuration.
IntegratedParserConfiguration	This is configuration uses a scanner that integrates both scanning of the document and binding namespaces.
NonValidatingConfiguration	This is the non validating parser configuration.
SchemaParsingConfig
SecurityConfiguration	This configuration allows Xerces to behave in a security-conscious manner; that is, it permits applications to instruct Xerces to limit certain operations that could be exploited by malicious document authors to cause a denail-of-service attack when the document is parsed.
SoftReferenceSymbolTableConfiguration	This parser configuration extends the default configuration allowing Xerces to handle usage scenarios where the names in the XML documents being parsed are mostly unique by installing a memory sensitive `SymbolTable`.
StandardParserConfiguration	This is the "standard" parser configuration.
XIncludeAwareParserConfiguration	This class is the configuration used to parse XML 1.0 and XML 1.1 documents and provides support for XInclude.
XIncludeParserConfiguration	This parser configuration includes an `XIncludeHandler` in the pipeline before the schema validator, or as the last component in the pipeline if there is no schema validator.
XML11Configuration	This class is the configuration used to parse XML 1.0 and XML 1.1 documents.
XML11DTDConfiguration	This class is the DTD-only parser configuration used to parse XML 1.0 and XML 1.1 documents.
XML11NonValidatingConfiguration	This class is the non vlaidating parser configuration used to parse XML 1.0 and XML 1.1 documents.
XMLGrammarCachingConfiguration	This configuration provides a generic way of using Xerces's grammar caching facilities.
XPointerParserConfiguration	This parser configuration includes an `XPointerHandler` in the pipeline before the schema validator, or as the last component in the pipeline if there is no schema validator.

Class Overview

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.

Summary

Public Methods
abstract 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.
abstract boolean	parse(boolean complete) Parses the document in a pull parsing fashion.
abstract void	setInputSource(XMLInputSource inputSource) Sets the input source for the document to parse.

[Expand]

Inherited Methods

From interface org.apache.xerces.xni.parser.XMLComponentManager

From interface org.apache.xerces.xni.parser.XMLParserConfiguration

Public Methods

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

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

Interfaces

Classes

Exceptions

XMLPullParserConfiguration

Class Overview

Summary

Public Methods

public abstract void cleanup ()

public abstract boolean parse (boolean complete)

Parameters

Returns

Throws

See Also

public abstract void setInputSource (XMLInputSource inputSource)

Parameters

Throws

See Also