001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017:
018: package org.apache.xerces.xni.parser;
019:
020: /**
021: * The component interface defines methods that must be implemented
022: * by components in a parser configuration. The component methods allow
023: * the component manager to initialize the component state and notify
024: * the component when feature and property values change.
025: *
026: * @see XMLComponentManager
027: *
028: * @author Andy Clark, IBM
029: *
030: * @version $Id: XMLComponent.java 447244 2006-09-18 05:20:40Z mrglavas $
031: */
032: public interface XMLComponent {
033:
034: //
035: // XMLComponent methods
036: //
037:
038: /**
039: * Resets the component. The component can query the component manager
040: * about any features and properties that affect the operation of the
041: * component.
042: *
043: * @param componentManager The component manager.
044: *
045: * @throws XNIException Thrown by component on initialization error.
046: */
047: public void reset(XMLComponentManager componentManager)
048: throws XMLConfigurationException;
049:
050: /**
051: * Returns a list of feature identifiers that are recognized by
052: * this component. This method may return null if no features
053: * are recognized by this component.
054: */
055: public String[] getRecognizedFeatures();
056:
057: /**
058: * Sets the state of a feature. This method is called by the component
059: * manager any time after reset when a feature changes state.
060: * <p>
061: * <strong>Note:</strong> Components should silently ignore features
062: * that do not affect the operation of the component.
063: *
064: * @param featureId The feature identifier.
065: * @param state The state of the feature.
066: *
067: * @throws XMLConfigurationException Thrown for configuration error.
068: * In general, components should
069: * only throw this exception if
070: * it is <strong>really</strong>
071: * a critical error.
072: */
073: public void setFeature(String featureId, boolean state)
074: throws XMLConfigurationException;
075:
076: /**
077: * Returns a list of property identifiers that are recognized by
078: * this component. This method may return null if no properties
079: * are recognized by this component.
080: */
081: public String[] getRecognizedProperties();
082:
083: /**
084: * Sets the value of a property. This method is called by the component
085: * manager any time after reset when a property changes value.
086: * <p>
087: * <strong>Note:</strong> Components should silently ignore properties
088: * that do not affect the operation of the component.
089: *
090: * @param propertyId The property identifier.
091: * @param value The value of the property.
092: *
093: * @throws XMLConfigurationException Thrown for configuration error.
094: * In general, components should
095: * only throw this exception if
096: * it is <strong>really</strong>
097: * a critical error.
098: */
099: public void setProperty(String propertyId, Object value)
100: throws XMLConfigurationException;
101:
102: /**
103: * Returns the default state for a feature, or null if this
104: * component does not want to report a default value for this
105: * feature.
106: *
107: * @param featureId The feature identifier.
108: *
109: * @since Xerces 2.2.0
110: */
111: public Boolean getFeatureDefault(String featureId);
112:
113: /**
114: * Returns the default state for a property, or null if this
115: * component does not want to report a default value for this
116: * property.
117: *
118: * @param propertyId The property identifier.
119: *
120: * @since Xerces 2.2.0
121: */
122: public Object getPropertyDefault(String propertyId);
123:
124: } // interface XMLComponent
|