| com.sun.xml.stream.xerces.xni.parser.XMLComponent
All known Subclasses: com.sun.xml.stream.XMLScanner, com.sun.xml.stream.XMLEntityManager, com.sun.xml.stream.XMLDTDScannerImpl, com.sun.xml.stream.XMLErrorReporter, com.sun.xml.stream.XMLNamespaceBinder, com.sun.xml.stream.XMLDocumentFragmentScannerImpl,
| XMLComponent | | public interface XMLComponent (Code) | | 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.
See Also: XMLComponentManager
author:
Andy Clark, IBM
version:
$Id: XMLComponent.java,v 1.2 2006/04/01 06:01:43 jeffsuttor Exp $ |
| getFeatureDefault | | public Boolean getFeatureDefault(String featureId)(Code) | | Returns the default state for a feature, or null if this
component does not want to report a default value for this
feature.
Parameters:
featureId - The feature identifier.
since:
Xerces 2.2.0 |
| getPropertyDefault | | public Object getPropertyDefault(String propertyId)(Code) | | Returns the default state for a property, or null if this
component does not want to report a default value for this
property.
Parameters:
propertyId - The property identifier.
since:
Xerces 2.2.0 |
| getRecognizedFeatures | | public String[] getRecognizedFeatures()(Code) | | 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()(Code) | | 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(Code) | | Resets the component. The component can query the component manager
about any features and properties that affect the operation of the
component.
Parameters:
componentManager - The component manager.
throws:
XNIException - Thrown by component on initialization error. |
| setFeature | | public void setFeature(String featureId, boolean state) throws XMLConfigurationException(Code) | | 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.
Parameters:
featureId - The feature identifier.
Parameters:
state - The state of the feature.
throws:
XMLConfigurationException - Thrown for configuration error.In general, components shouldonly throw this exception ifit is reallya critical error. |
| setProperty | | public void setProperty(String propertyId, Object value) throws XMLConfigurationException(Code) | | 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.
Parameters:
propertyId - The property identifier.
Parameters:
value - The value of the property.
throws:
XMLConfigurationException - Thrown for configuration error.In general, components shouldonly throw this exception ifit is reallya critical error. |
|
|