org.apache.xerces.util

Class ParserConfigurationSettings

public class ParserConfigurationSettings extends Object implements 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,v 1.11 2004/04/25 05:05:50 mrglavas Exp $

Author: Andy Clark, IBM

Field Summary
protected HashMapfFeatures
Features.
protected XMLComponentManagerfParentSettings
Parent parser configuration settings.
protected HashMapfProperties
Properties.
protected ArrayListfRecognizedFeatures
Recognized features.
protected ArrayListfRecognizedProperties
Recognized properties.
protected static StringPARSER_SETTINGS
Constructor Summary
ParserConfigurationSettings()
Default Constructor.
ParserConfigurationSettings(XMLComponentManager parent)
Constructs a parser configuration settings object with a parent settings object.
Method Summary
voidaddRecognizedFeatures(String[] featureIds)
Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
voidaddRecognizedProperties(String[] propertyIds)
Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
protected voidcheckFeature(String featureId)
Check a feature.
protected voidcheckProperty(String propertyId)
Check a property.
booleangetFeature(String featureId)
Returns the state of a feature.
ObjectgetProperty(String propertyId)
Returns the value of a property.
voidsetFeature(String featureId, boolean state)
Set the state of a feature.
voidsetProperty(String propertyId, Object value)
setProperty

Field Detail

fFeatures

protected HashMap fFeatures
Features.

fParentSettings

protected XMLComponentManager fParentSettings
Parent parser configuration settings.

fProperties

protected HashMap fProperties
Properties.

fRecognizedFeatures

protected ArrayList fRecognizedFeatures
Recognized features.

fRecognizedProperties

protected ArrayList fRecognizedProperties
Recognized properties.

PARSER_SETTINGS

protected static final String PARSER_SETTINGS

Constructor Detail

ParserConfigurationSettings

public ParserConfigurationSettings()
Default Constructor.

ParserConfigurationSettings

public ParserConfigurationSettings(XMLComponentManager parent)
Constructs a parser configuration settings object with a parent settings object.

Method Detail

addRecognizedFeatures

public void addRecognizedFeatures(String[] featureIds)
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.

addRecognizedProperties

public void addRecognizedProperties(String[] propertyIds)
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.

checkFeature

protected void checkFeature(String featureId)
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)
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.

getFeature

public boolean getFeature(String featureId)
Returns the state of a feature.

Parameters: featureId The feature identifier.

Returns: true if the feature is supported

Throws: 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)
Returns the value of a property.

Parameters: propertyId The property identifier.

Returns: the value of the property

Throws: XMLConfigurationException Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

setFeature

public void setFeature(String featureId, boolean state)
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.

setProperty

public void setProperty(String propertyId, Object value)
setProperty

Parameters: propertyId value

Throws: org.apache.xerces.xni.parser.XMLConfigurationException If the requested feature is not known.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.