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.
| Modifier and Type | Method and Description |
|---|---|
| public void | addRecognizedFeatures(String[]
An array of the additional feature identifiers
to be recognized. featureIds)Allows a parser to add parser specific features to be recognized and managed by the parser configuration. |
| public void | addRecognizedProperties(String[]
An array of the additional property identifiers
to be recognized. propertyIds)Allows a parser to add parser specific properties to be recognized and managed by the parser configuration. |
| public XMLDocumentHandler | |
| public XMLDTDContentModelHandler | |
| public XMLDTDHandler | |
| public XMLEntityResolver | |
| public XMLErrorHandler | |
| public boolean | getFeature(String
The feature identifier. featureId)Redeclares org. |
| public Locale | |
| public Object | getProperty(String
The property identifier. propertyId)Redeclares org. |
| public void | parse(XMLInputSource
The input source for the top-level of the
XML document. inputSource)Parse an XML document. |
| public void | setDocumentHandler(XMLDocumentHandler
The document handler. documentHandler)Sets the document handler to receive information about the document. |
| public void | setDTDContentModelHandler(XMLDTDContentModelHandler
The DTD content model handler. dtdContentModelHandler)Sets the DTD content model handler. |
| public void | |
| public void | setEntityResolver(XMLEntityResolver
The new entity resolver. entityResolver)Sets the entity resolver. |
| public void | |
| public void | setFeature(String
The feature identifier. featureId, boolean The state of the feature. state)Sets the state of a feature. |
| public void | |
| public void | setProperty(String
The property identifier. propertyId, Object The value of the property. value)Sets the value of a property. |
| addRecognizedFeatures | back to summary |
|---|---|
| public void addRecognizedFeatures(String[] featureIds) Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
| |
| addRecognizedProperties | back to summary |
|---|---|
| public void addRecognizedProperties(String[] propertyIds) Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
| |
| getDocumentHandler | back to summary |
|---|---|
| public XMLDocumentHandler getDocumentHandler() Returns the registered document handler. | |
| getDTDContentModelHandler | back to summary |
|---|---|
| public XMLDTDContentModelHandler getDTDContentModelHandler() Returns the registered DTD content model handler. | |
| getDTDHandler | back to summary |
|---|---|
| public XMLDTDHandler getDTDHandler() Returns the registered DTD handler. | |
| getEntityResolver | back to summary |
|---|---|
| public XMLEntityResolver getEntityResolver() Returns the registered entity resolver. | |
| getErrorHandler | back to summary |
|---|---|
| public XMLErrorHandler getErrorHandler() Returns the registered error handler. | |
| getFeature | back to summary |
|---|---|
| public boolean getFeature(String featureId) throws XMLConfigurationException Redeclares org. Returns the state of a feature.
| |
| getLocale | back to summary |
|---|---|
| public Locale getLocale() Returns the locale. | |
| getProperty | back to summary |
|---|---|
| public Object getProperty(String propertyId) throws XMLConfigurationException Redeclares org. Returns the value of a property.
| |
| parse | back to summary |
|---|---|
| public void parse(XMLInputSource inputSource) throws XNIException, IOException 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.
| |
| setDocumentHandler | back to summary |
|---|---|
| public void setDocumentHandler(XMLDocumentHandler documentHandler) Sets the document handler to receive information about the document.
| |
| setDTDContentModelHandler | back to summary |
|---|---|
| public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler) Sets the DTD content model handler.
| |
| setDTDHandler | back to summary |
|---|---|
| public void setDTDHandler(XMLDTDHandler dtdHandler) Sets the DTD handler.
| |
| setEntityResolver | back to summary |
|---|---|
| public void setEntityResolver(XMLEntityResolver entityResolver) Sets the entity resolver.
| |
| setErrorHandler | back to summary |
|---|---|
| public void setErrorHandler(XMLErrorHandler errorHandler) Sets the error handler.
| |
| setFeature | back to summary |
|---|---|
| public void setFeature(String featureId, boolean state) throws XMLConfigurationException Sets the state of a feature. This method is called by the parser and gets propagated to components in this parser configuration.
| |
| setLocale | back to summary |
|---|---|
| public void setLocale(Locale locale) throws XNIException Set the locale to use for messages.
| |
| setProperty | back to summary |
|---|---|
| public void setProperty(String propertyId, Object value) throws XMLConfigurationException Sets the value of a property. This method is called by the parser and gets propagated to components in this parser configuration.
| |