|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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.
XMLComponentManager| Method Summary | |
|---|---|
java.lang.Boolean |
getFeatureDefault(java.lang.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. |
java.lang.Object |
getPropertyDefault(java.lang.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. |
java.lang.String[] |
getRecognizedFeatures()
Returns a list of feature identifiers that are recognized by this component. |
java.lang.String[] |
getRecognizedProperties()
Returns a list of property identifiers that are recognized by this component. |
void |
reset(XMLComponentManager componentManager)
Resets the component. |
void |
setFeature(java.lang.String featureId,
boolean state)
Sets the state of a feature. |
void |
setProperty(java.lang.String propertyId,
java.lang.Object value)
Sets the value of a property. |
| Method Detail |
|---|
void reset(XMLComponentManager componentManager)
throws XMLConfigurationException
componentManager - The component manager.
XNIException - Thrown by component on initialization error.
XMLConfigurationExceptionjava.lang.String[] getRecognizedFeatures()
void setFeature(java.lang.String featureId,
boolean state)
throws XMLConfigurationException
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.java.lang.String[] getRecognizedProperties()
void setProperty(java.lang.String propertyId,
java.lang.Object value)
throws XMLConfigurationException
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.java.lang.Boolean getFeatureDefault(java.lang.String featureId)
featureId - The feature identifier.java.lang.Object getPropertyDefault(java.lang.String propertyId)
propertyId - The property identifier.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||