org.apache.xerces.xni.parser
Interface XMLComponent
public interface XMLComponent
The component interface defines methods that must be implemented
by components in a parser configuration. The component methods allow
the component manager to initialize the component state and notify
the component when feature and property values change.
$Id: XMLComponent.java 447244 2006-09-18 05:20:40Z mrglavas $ Boolean | getFeatureDefault(String featureId) - Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature.
|
Object | getPropertyDefault(String propertyId) - Returns the default state for a property, or null if this
component does not want to report a default value for this
property.
|
String[] | getRecognizedFeatures() - Returns a list of feature identifiers that are recognized by
this component.
|
String[] | getRecognizedProperties() - Returns a list of property identifiers that are recognized by
this component.
|
void | reset(XMLComponentManager componentManager) - Resets the component.
|
void | setFeature(String featureId, boolean state) - Sets the state of a feature.
|
void | setProperty(String propertyId, Object value) - Sets the value of a property.
|
getFeatureDefault
public Boolean getFeatureDefault(String featureId)
Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature.
featureId
- The feature identifier.
getPropertyDefault
public Object getPropertyDefault(String propertyId)
Returns the default state for a property, or null if this
component does not want to report a default value for this
property.
propertyId
- The property identifier.
getRecognizedFeatures
public String[] getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by
this component. This method may return null if no features
are recognized by this component.
getRecognizedProperties
public String[] getRecognizedProperties()
Returns a list of property identifiers that are recognized by
this component. This method may return null if no properties
are recognized by this component.
reset
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException
Resets the component. The component can query the component manager
about any features and properties that affect the operation of the
component.
componentManager
- The component manager.
setFeature
public void setFeature(String featureId,
boolean state)
throws XMLConfigurationException
Sets the state of a feature. This method is called by the component
manager any time after reset when a feature changes state.
Note: Components should silently ignore features
that do not affect the operation of the component.
featureId
- The feature identifier.state
- The state of the feature.
XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.
setProperty
public void setProperty(String propertyId,
Object value)
throws XMLConfigurationException
Sets the value of a property. This method is called by the component
manager any time after reset when a property changes value.
Note: Components should silently ignore properties
that do not affect the operation of the component.
propertyId
- The property identifier.value
- The value of the property.
XMLConfigurationException
- Thrown for configuration error.
In general, components should
only throw this exception if
it is really
a critical error.
Copyright B) 1999-2007 The Apache Software Foundation. All Rights Reserved.