org.apache.xerces.xni.parser.XMLParserConfiguration |
Represents a parser configuration. The parser configuration maintains a table of recognized features and properties, assembles components for the parsing pipeline, and is responsible for initiating parsing of an XML document.
By separating the configuration of a parser from the specific parser instance, applications can create new configurations and re-use the existing parser components and external API generators (e.g. the DOMParser and SAXParser).
The internals of any specific parser configuration instance are hidden. Therefore, each configuration may implement the parsing mechanism any way necessary. However, the parser configuration should follow these guidelines:
reset
method on each component before parsing.
This is only required if the configuration is re-using existing
components that conform to the XMLComponent
interface.
If the configuration uses all custom parts, then it is free to
implement everything as it sees fit as long as it follows the
other guidelines.
setFeature
and setProperty
method
on each component during parsing to propagate features and properties
that have changed. This is only required if the configuration is
re-using existing components that conform to the XMLComponent
interface. If the configuration uses all custom parts, then it is free
to implement everything as it sees fit as long as it follows the other
guidelines.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Allows a parser to add parser specific features to be recognized
and managed by the parser configuration.
| |||||||||||
Allows a parser to add parser specific properties to be recognized
and managed by the parser configuration.
| |||||||||||
Returns the registered DTD content model handler.
| |||||||||||
Returns the registered DTD handler.
| |||||||||||
Returns the registered document handler.
| |||||||||||
Returns the registered entity resolver.
| |||||||||||
Returns the registered error handler.
| |||||||||||
Returns the state of a feature.
| |||||||||||
Returns the locale.
| |||||||||||
Returns the value of a property.
| |||||||||||
Parse an XML document.
| |||||||||||
Sets the DTD content model handler.
| |||||||||||
Sets the DTD handler.
| |||||||||||
Sets the document handler to receive information about the document.
| |||||||||||
Sets the entity resolver.
| |||||||||||
Sets the error handler.
| |||||||||||
Sets the state of a feature.
| |||||||||||
Set the locale to use for messages.
| |||||||||||
Sets the value of a property.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
org.apache.xerces.xni.parser.XMLComponentManager
|
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
featureIds | An array of the additional feature identifiers to be recognized. |
---|
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
propertyIds | An array of the additional property identifiers to be recognized. |
---|
Returns the registered DTD content model handler.
Returns the state of a feature.
featureId | The feature identifier. |
---|
XMLConfigurationException | Thrown if there is a configuration error. |
---|
Returns the value of a property.
propertyId | The property identifier. |
---|
XMLConfigurationException | Thrown if there is a configuration error. |
---|
Parse an XML document.
The parser can use this method to instruct this configuration to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).
Parsers may not invoke this method while a parse is in progress. Once a parse is complete, the parser may then parse another XML document.
This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.
When this method returns, all characters streams and byte streams opened by the parser are closed.
inputSource | The input source for the top-level of the XML document. |
---|
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. |
Sets the DTD content model handler.
dtdContentModelHandler | The DTD content model handler. |
---|
Sets the DTD handler.
dtdHandler | The DTD handler. |
---|
Sets the document handler to receive information about the document.
documentHandler | The document handler. |
---|
Sets the entity resolver.
entityResolver | The new entity resolver. |
---|
Sets the error handler.
errorHandler | The error resolver. |
---|
Sets the state of a feature. This method is called by the parser and gets propagated to components in this parser configuration.
featureId | The feature identifier. |
---|---|
state | The state of the feature. |
XMLConfigurationException | Thrown if there is a configuration error. |
---|
Set the locale to use for messages.
locale | The locale object to use for localization of messages. |
---|
XNIException | Thrown if the parser does not support the specified locale. |
---|
Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.
propertyId | The property identifier. |
---|---|
value | The value of the property. |
XMLConfigurationException | Thrown if there is a configuration error. |
---|