Package org.apache.xerces.util
Class ParserConfigurationSettings
java.lang.Object
org.apache.xerces.util.ParserConfigurationSettings
- All Implemented Interfaces:
org.apache.xerces.xni.parser.XMLComponentManager
- Direct Known Subclasses:
BasicParserConfiguration
,DOMConfigurationImpl
,XML11Configuration
,XML11DTDConfiguration
,XML11NonValidatingConfiguration
public class ParserConfigurationSettings
extends Object
implements org.apache.xerces.xni.parser.XMLComponentManager
This class implements the basic operations for managing parser
configuration features and properties. This utility class can
be used as a base class for parser configurations or separately
to encapsulate a number of parser settings as a component
manager.
This class can be constructed with a "parent" settings object
(in the form of an XMLComponentManager
) that allows
parser configuration settings to be "chained" together.
- Version:
- $Id: ParserConfigurationSettings.java 447241 2006-09-18 05:12:57Z mrglavas $
- Author:
- Andy Clark, IBM
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected HashMap
Features.protected org.apache.xerces.xni.parser.XMLComponentManager
Parent parser configuration settings.protected HashMap
Properties.protected ArrayList
Recognized features.protected ArrayList
Recognized properties.protected static final String
-
Constructor Summary
ConstructorsConstructorDescriptionDefault Constructor.ParserConfigurationSettings
(org.apache.xerces.xni.parser.XMLComponentManager parent) Constructs a parser configuration settings object with a parent settings object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.protected void
checkFeature
(String featureId) Check a feature.protected void
checkProperty
(String propertyId) Check a property.boolean
getFeature
(String featureId) Returns the state of a feature.getProperty
(String propertyId) Returns the value of a property.void
setFeature
(String featureId, boolean state) Set the state of a feature.void
setProperty
(String propertyId, Object value) setProperty
-
Field Details
-
PARSER_SETTINGS
- See Also:
-
fRecognizedProperties
Recognized properties. -
fProperties
Properties. -
fRecognizedFeatures
Recognized features. -
fFeatures
Features. -
fParentSettings
protected org.apache.xerces.xni.parser.XMLComponentManager fParentSettingsParent parser configuration settings.
-
-
Constructor Details
-
ParserConfigurationSettings
public ParserConfigurationSettings()Default Constructor. -
ParserConfigurationSettings
public ParserConfigurationSettings(org.apache.xerces.xni.parser.XMLComponentManager parent) Constructs a parser configuration settings object with a parent settings object.
-
-
Method Details
-
addRecognizedFeatures
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.- Parameters:
featureIds
- An array of the additional feature identifiers to be recognized.
-
setFeature
public void setFeature(String featureId, boolean state) throws org.apache.xerces.xni.parser.XMLConfigurationException Set the state of a feature. Set the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.- Parameters:
featureId
- The unique identifier (URI) of the feature.state
- The requested state of the feature (true or false).- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- If the requested feature is not known.
-
addRecognizedProperties
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.- Parameters:
propertyIds
- An array of the additional property identifiers to be recognized.
-
setProperty
public void setProperty(String propertyId, Object value) throws org.apache.xerces.xni.parser.XMLConfigurationException setProperty- Parameters:
propertyId
-value
-- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- If the requested feature is not known.
-
getFeature
public boolean getFeature(String featureId) throws org.apache.xerces.xni.parser.XMLConfigurationException Returns the state of a feature.- Specified by:
getFeature
in interfaceorg.apache.xerces.xni.parser.XMLComponentManager
- Parameters:
featureId
- The feature identifier.- Returns:
- true if the feature is supported
- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
-
getProperty
public Object getProperty(String propertyId) throws org.apache.xerces.xni.parser.XMLConfigurationException Returns the value of a property.- Specified by:
getProperty
in interfaceorg.apache.xerces.xni.parser.XMLComponentManager
- Parameters:
propertyId
- The property identifier.- Returns:
- the value of the property
- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.
-
checkFeature
protected void checkFeature(String featureId) throws org.apache.xerces.xni.parser.XMLConfigurationException Check a feature. If feature is known and supported, this method simply returns. Otherwise, the appropriate exception is thrown.- Parameters:
featureId
- The unique identifier (URI) of the feature.- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- If the requested feature is not known.
-
checkProperty
protected void checkProperty(String propertyId) throws org.apache.xerces.xni.parser.XMLConfigurationException Check a property. If the property is known and supported, this method simply returns. Otherwise, the appropriate exception is thrown.- Parameters:
propertyId
- The unique identifier (URI) of the property being set.- Throws:
org.apache.xerces.xni.parser.XMLConfigurationException
- If the requested feature is not known.
-