OpenJDK 27 · com.sun.org.apache.xerces.internal.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:

Call the 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.
Call the 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.
Pass the same unique String references for all symbols that are propagated to the registered handlers. Symbols include, but may not be limited to, the names of elements and attributes (including their uri, prefix, and localpart). This is suggested but not an absolute must. However, the standard parser components may require access to the same symbol table for creation of unique symbol references to be propagated in the XNI pipeline.

Method Summary

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	getDocumentHandler() Returns the registered document handler.
public XMLDTDContentModelHandler	getDTDContentModelHandler() Returns the registered DTD content model handler.
public XMLDTDHandler	getDTDHandler() Returns the registered DTD handler.
public XMLEntityResolver	getEntityResolver() Returns the registered entity resolver.
public XMLErrorHandler	getErrorHandler() Returns the registered error handler.
public boolean	getFeature(String The feature identifier. featureId) Redeclares com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getFeature. Returns the state of a feature.
public Locale	getLocale() Returns the locale.
public Object	getProperty(String The property identifier. propertyId) Redeclares com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getProperty. Returns the value of a property.
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	setDTDHandler(XMLDTDHandler The DTD handler. dtdHandler) Sets the DTD handler.
public void	setEntityResolver(XMLEntityResolver The new entity resolver. entityResolver) Sets the entity resolver.
public void	setErrorHandler(XMLErrorHandler The error resolver. errorHandler) Sets the error handler.
public void	setFeature(String The feature identifier. featureId, boolean The state of the feature. state) Sets the state of a feature.
public void	setLocale(Locale The locale object to use for localization of messages. locale) Set the locale to use for messages.
public void	setProperty(String The property identifier. propertyId, Object The value of the property. value) Sets the value of a property.

Inherited from com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager:: getFeature getFeatureState getProperty getPropertyState

Method Detail

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. Parameters featureIds:String[] An array of the additional feature identifiers to be recognized.

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.

Parameters

featureIds:String[]: An array of the additional feature identifiers to be recognized.

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. Parameters propertyIds:String[] An array of the additional property identifiers to be recognized.

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.

Parameters

propertyIds:String[]: An array of the additional property identifiers to be recognized.

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 com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getFeature. Returns the state of a feature. Parameters featureId:String The feature identifier. Exceptions XMLConfigurationException: Thrown if there is a configuration error.

getFeature

back to summary

public boolean getFeature(String featureId) throws XMLConfigurationException

Redeclares com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getFeature.

Returns the state of a feature.

Parameters

featureId:String: The feature identifier.

Exceptions

XMLConfigurationException:: Thrown if there is a configuration error.

getLocale	back to summary
public Locale getLocale() Returns the locale.

getProperty	back to summary
public Object getProperty(String propertyId) throws XMLConfigurationException Redeclares com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getProperty. Returns the value of a property. Parameters propertyId:String The property identifier. Exceptions XMLConfigurationException: Thrown if there is a configuration error.

getProperty

back to summary

public Object getProperty(String propertyId) throws XMLConfigurationException

Redeclares com.sun.org.apache.xerces.internal.xni.parser.XMLComponentManager.getProperty.

Returns the value of a property.

Parameters

propertyId:String: The property identifier.

Exceptions

XMLConfigurationException:: Thrown if there is a configuration error.

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. Parameters inputSource:XMLInputSource The input source for the top-level of the XML document. Exceptions 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.

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.

Parameters

inputSource:XMLInputSource: The input source for the top-level of the XML document.

Exceptions

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.

setDocumentHandler	back to summary
public void setDocumentHandler(XMLDocumentHandler documentHandler) Sets the document handler to receive information about the document. Parameters documentHandler:XMLDocumentHandler The document handler.

setDocumentHandler

back to summary

public void setDocumentHandler(XMLDocumentHandler documentHandler)

Sets the document handler to receive information about the document.

Parameters

documentHandler:XMLDocumentHandler: The document handler.

setDTDContentModelHandler	back to summary
public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler) Sets the DTD content model handler. Parameters dtdContentModelHandler:XMLDTDContentModelHandler The DTD content model handler.

setDTDContentModelHandler

back to summary

public void setDTDContentModelHandler(XMLDTDContentModelHandler dtdContentModelHandler)

Sets the DTD content model handler.

Parameters

dtdContentModelHandler:XMLDTDContentModelHandler: The DTD content model handler.

setDTDHandler	back to summary
public void setDTDHandler(XMLDTDHandler dtdHandler) Sets the DTD handler. Parameters dtdHandler:XMLDTDHandler The DTD handler.

setDTDHandler

back to summary

public void setDTDHandler(XMLDTDHandler dtdHandler)

Sets the DTD handler.

Parameters

dtdHandler:XMLDTDHandler: The DTD handler.

setEntityResolver	back to summary
public void setEntityResolver(XMLEntityResolver entityResolver) Sets the entity resolver. Parameters entityResolver:XMLEntityResolver The new entity resolver.

setEntityResolver

back to summary

public void setEntityResolver(XMLEntityResolver entityResolver)

Sets the entity resolver.

Parameters

entityResolver:XMLEntityResolver: The new entity resolver.

setErrorHandler	back to summary
public void setErrorHandler(XMLErrorHandler errorHandler) Sets the error handler. Parameters errorHandler:XMLErrorHandler The error resolver.

setErrorHandler

back to summary

public void setErrorHandler(XMLErrorHandler errorHandler)

Sets the error handler.

Parameters

errorHandler:XMLErrorHandler: The error resolver.

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. Parameters featureId:String The feature identifier. state:boolean The state of the feature. Exceptions XMLConfigurationException: Thrown if there is a configuration error.

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.

Parameters

featureId:String: The feature identifier.
state:boolean: The state of the feature.

Exceptions

XMLConfigurationException:: Thrown if there is a configuration error.

setLocale	back to summary
public void setLocale(Locale locale) throws XNIException Set the locale to use for messages. Parameters locale:Locale The locale object to use for localization of messages. Exceptions XNIException: Thrown if the parser does not support the specified locale.

setLocale

back to summary

public void setLocale(Locale locale) throws XNIException

Set the locale to use for messages.

Parameters

locale:Locale: The locale object to use for localization of messages.

Exceptions

XNIException:: Thrown if the parser does not support the specified locale.

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. Parameters propertyId:String The property identifier. value:Object The value of the property. Exceptions XMLConfigurationException: Thrown if there is a configuration error.

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.

Parameters

propertyId:String: The property identifier.
value:Object: The value of the property.

Exceptions

XMLConfigurationException:: Thrown if there is a configuration error.

public Interface XMLParserConfiguration

Method Summary

Method Detail