public interface XMLParserConfiguration extends XMLComponentManager
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 |
---|---|
void |
addRecognizedFeatures(String[] featureIds)
Allows a parser to add parser specific features to be recognized
and managed by the parser configuration.
|
void |
addRecognizedProperties(String[] propertyIds)
Allows a parser to add parser specific properties to be recognized
and managed by the parser configuration.
|
XMLDocumentHandler |
getDocumentHandler()
Returns the registered document handler.
|
XMLDTDContentModelHandler |
getDTDContentModelHandler()
Returns the registered DTD content model handler.
|
XMLDTDHandler |
getDTDHandler()
Returns the registered DTD handler.
|
XMLEntityResolver |
getEntityResolver()
Returns the registered entity resolver.
|
XMLErrorHandler |
getErrorHandler()
Returns the registered error handler.
|
boolean |
getFeature(String featureId)
Returns the state of a feature.
|
Locale |
getLocale()
Returns the locale.
|
Object |
getProperty(String propertyId)
Returns the value of a property.
|
void |
parse(XMLInputSource inputSource)
Parse an XML document.
|
void |
setDocumentHandler(XMLDocumentHandler documentHandler)
Sets the document handler to receive information about the document.
|
void |
setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
Sets the DTD content model handler.
|
void |
setDTDHandler(XMLDTDHandler dtdHandler)
Sets the DTD handler.
|
void |
setEntityResolver(XMLEntityResolver entityResolver)
Sets the entity resolver.
|
void |
setErrorHandler(XMLErrorHandler errorHandler)
Sets the error handler.
|
void |
setFeature(String featureId,
boolean state)
Sets the state of a feature.
|
void |
setLocale(Locale locale)
Set the locale to use for messages.
|
void |
setProperty(String propertyId,
Object value)
Sets the value of a property.
|
void parse(XMLInputSource inputSource) throws XNIException, IOException
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.void addRecognizedFeatures(String[] featureIds)
featureIds
- An array of the additional feature identifiers
to be recognized.void setFeature(String featureId, boolean state) throws XMLConfigurationException
featureId
- The feature identifier.state
- The state of the feature.XMLConfigurationException
- Thrown if there is a configuration
error.boolean getFeature(String featureId) throws XMLConfigurationException
getFeature
in interface XMLComponentManager
featureId
- The feature identifier.XMLConfigurationException
- Thrown if there is a configuration
error.void addRecognizedProperties(String[] propertyIds)
propertyIds
- An array of the additional property identifiers
to be recognized.void setProperty(String propertyId, Object value) throws XMLConfigurationException
propertyId
- The property identifier.value
- The value of the property.XMLConfigurationException
- Thrown if there is a configuration
error.Object getProperty(String propertyId) throws XMLConfigurationException
getProperty
in interface XMLComponentManager
propertyId
- The property identifier.XMLConfigurationException
- Thrown if there is a configuration
error.void setErrorHandler(XMLErrorHandler errorHandler)
errorHandler
- The error resolver.XMLErrorHandler getErrorHandler()
void setDocumentHandler(XMLDocumentHandler documentHandler)
documentHandler
- The document handler.XMLDocumentHandler getDocumentHandler()
void setDTDHandler(XMLDTDHandler dtdHandler)
dtdHandler
- The DTD handler.XMLDTDHandler getDTDHandler()
void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)
dtdContentModelHandler
- The DTD content model handler.XMLDTDContentModelHandler getDTDContentModelHandler()
void setEntityResolver(XMLEntityResolver entityResolver)
entityResolver
- The new entity resolver.XMLEntityResolver getEntityResolver()
void setLocale(Locale locale) throws XNIException
locale
- The locale object to use for localization of messages.XNIException
- Thrown if the parser does not support the
specified locale.Locale getLocale()
Copyright © 2017 JBoss by Red Hat. All rights reserved.