Package 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.
    Version:
    $Id: XMLComponent.java 699892 2008-09-28 21:08:27Z mrglavas $
    Author:
    Andy Clark, IBM
    See Also:
    XMLComponentManager

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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

      • getRecognizedFeatures

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

      • setFeature

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

        Parameters:
        featureId - The feature identifier.
        state - The state of the feature.
        Throws:
        XMLConfigurationException - Thrown for configuration error. In general, components should only throw this exception if it is really a critical error.

      • getRecognizedProperties

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

      • setProperty

        void setProperty​(java.lang.String propertyId,
                 java.lang.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.

        Parameters:
        propertyId - The property identifier.
        value - 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.

      • getFeatureDefault

        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.
        Parameters:
        featureId - The feature identifier.
        Since:
        Xerces 2.2.0

      • getPropertyDefault

        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.
        Parameters:
        propertyId - The property identifier.
        Since:
        Xerces 2.2.0