org.apache.xerces.util
Class ParserConfigurationSettings

java.lang.Object
  org.apache.xerces.util.ParserConfigurationSettings

All Implemented Interfaces:

XMLComponentManager

Direct Known Subclasses:

BasicParserConfiguration, DOMConfigurationImpl, XML11Configuration, XML11DTDConfiguration, XML11NonValidatingConfiguration

public class ParserConfigurationSettings
extends java.lang.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 447241 2006-09-18 05:12:57Z mrglavas $

Author:

Andy Clark, IBM

Constructor Summary

ParserConfigurationSettings()
Default Constructor.

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

Method Summary

void	addRecognizedFeatures(java.lang.String[] featureIds) Allows a parser to add parser specific features to be recognized and managed by the parser configuration.
void	addRecognizedProperties(java.lang.String[] propertyIds) Allows a parser to add parser specific properties to be recognized and managed by the parser configuration.
boolean	getFeature(java.lang.String featureId) Returns the state of a feature.
java.lang.Object	getProperty(java.lang.String propertyId) Returns the value of a property.
void	setFeature(java.lang.String featureId, boolean state) Set the state of a feature.
void	setProperty(java.lang.String propertyId, java.lang.Object value) setProperty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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(java.lang.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.

setFeature

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

XMLConfigurationException - If the requested feature is not known.

addRecognizedProperties

public void addRecognizedProperties(java.lang.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.

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws XMLConfigurationException

setProperty

Parameters:

propertyId -

value -

Throws:

XMLConfigurationException - If the requested feature is not known.

getFeature

public boolean getFeature(java.lang.String featureId)
                   throws XMLConfigurationException

Returns the state of a feature.

Specified by:

getFeature in interface XMLComponentManager

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 java.lang.Object getProperty(java.lang.String propertyId)
                             throws XMLConfigurationException

Returns the value of a property.

Specified by:

getProperty in interface XMLComponentManager

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.