jdk7u.jaxp.org.apache.xerces.external.util

Class ParserConfigurationSettings

java.lang.Object

jdk7u.jaxp.org.apache.xerces.external.util.ParserConfigurationSettings

All Implemented Interfaces:

XMLComponentManager

Direct Known Subclasses:

BasicParserConfiguration, DOMConfigurationImpl, XML11Configuration, XML11DTDConfiguration, XML11NonValidatingConfiguration

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.6 2010-11-01 04:40:14 joehw Exp $

Author:

Andy Clark, IBM

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Boolean>	fFeatures Features.
protected XMLComponentManager	fParentSettings Parent parser configuration settings.
protected Map<String,Object>	fProperties Properties.
protected Set<String>	fRecognizedFeatures Recognized features.
protected Set<String>	fRecognizedProperties Recognized properties.
protected static String	PARSER_SETTINGS

Constructor Summary

Constructors

Constructor and Description
ParserConfigurationSettings() Default Constructor.
ParserConfigurationSettings(XMLComponentManager parent) Constructs a parser configuration settings object with a parent settings object.

Method Summary

Methods

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.
protected FeatureState	checkFeature(String featureId) Check a feature.
protected PropertyState	checkProperty(String propertyId) Check a property.
boolean	getFeature(String featureId) Returns the state of a feature.
boolean	getFeature(String featureId, boolean defaultValue) Returns the state of a feature.
FeatureState	getFeatureState(String featureId)
Object	getProperty(String propertyId) Returns the value of a property.
Object	getProperty(String propertyId, Object defaultValue) Returns the value of a property.
PropertyState	getPropertyState(String propertyId)
void	setFeature(String featureId, boolean state) Set the state of a feature.
void	setProperty(String propertyId, Object value) setProperty

Methods inherited from class java.lang.Object

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

Field Detail

PARSER_SETTINGS

protected static final String PARSER_SETTINGS

See Also:

Constant Field Values

fRecognizedProperties

protected Set<String> fRecognizedProperties

Recognized properties.

fProperties

protected Map<String,Object> fProperties

Properties.

fRecognizedFeatures

protected Set<String> fRecognizedFeatures

Recognized features.

fFeatures

protected Map<String,Boolean> fFeatures

Features.

fParentSettings

protected XMLComponentManager fParentSettings

Parent parser configuration 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.

setFeature

public void setFeature(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(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(String propertyId,
               Object value)
                 throws XMLConfigurationException

setProperty

Parameters:

propertyId -

value -

Throws:

XMLConfigurationException - If the requested feature is not known.

getFeature

public final boolean getFeature(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.

getFeature

public final boolean getFeature(String featureId,
                 boolean defaultValue)

Description copied from interface: XMLComponentManager

Returns the state of a feature. Does not throw exceptions.

Specified by:

getFeature in interface XMLComponentManager

Parameters:

featureId - The feature identifier.

defaultValue - Default value if future is not available.

getFeatureState

public FeatureState getFeatureState(String featureId)

Specified by:

getFeatureState in interface XMLComponentManager

getProperty

public final Object getProperty(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.

getProperty

public final Object getProperty(String propertyId,
                 Object defaultValue)

Description copied from interface: XMLComponentManager

Returns the value of a property. Does not throw exceptions.

Specified by:

getProperty in interface XMLComponentManager

Parameters:

propertyId - The property identifier.

defaultValue - Return value if property is not available.

getPropertyState

public PropertyState getPropertyState(String propertyId)

Specified by:

getPropertyState in interface XMLComponentManager

checkFeature

protected FeatureState checkFeature(String featureId)
                             throws 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:

XMLConfigurationException - If the requested feature is not known.

checkProperty

protected PropertyState checkProperty(String propertyId)
                               throws 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:

XMLConfigurationException - If the requested feature is not known.