001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 2000-2002 The Apache Software Foundation.
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package com.sun.xml.stream.xerces.xni.parser;
059:
060: /**
061: * The component interface defines methods that must be implemented
062: * by components in a parser configuration. The component methods allow
063: * the component manager to initialize the component state and notify
064: * the component when feature and property values change.
065: *
066: * @see XMLComponentManager
067: *
068: * @author Andy Clark, IBM
069: *
070: * @version $Id: XMLComponent.java,v 1.2 2006/04/01 06:01:43 jeffsuttor Exp $
071: */
072: public interface XMLComponent {
073:
074: //
075: // XMLComponent methods
076: //
077:
078: /**
079: * Resets the component. The component can query the component manager
080: * about any features and properties that affect the operation of the
081: * component.
082: *
083: * @param componentManager The component manager.
084: *
085: * @throws XNIException Thrown by component on initialization error.
086: */
087: public void reset(XMLComponentManager componentManager)
088: throws XMLConfigurationException;
089:
090: /**
091: * Returns a list of feature identifiers that are recognized by
092: * this component. This method may return null if no features
093: * are recognized by this component.
094: */
095: public String[] getRecognizedFeatures();
096:
097: /**
098: * Sets the state of a feature. This method is called by the component
099: * manager any time after reset when a feature changes state.
100: * <p>
101: * <strong>Note:</strong> Components should silently ignore features
102: * that do not affect the operation of the component.
103: *
104: * @param featureId The feature identifier.
105: * @param state The state of the feature.
106: *
107: * @throws XMLConfigurationException Thrown for configuration error.
108: * In general, components should
109: * only throw this exception if
110: * it is <strong>really</strong>
111: * a critical error.
112: */
113: public void setFeature(String featureId, boolean state)
114: throws XMLConfigurationException;
115:
116: /**
117: * Returns a list of property identifiers that are recognized by
118: * this component. This method may return null if no properties
119: * are recognized by this component.
120: */
121: public String[] getRecognizedProperties();
122:
123: /**
124: * Sets the value of a property. This method is called by the component
125: * manager any time after reset when a property changes value.
126: * <p>
127: * <strong>Note:</strong> Components should silently ignore properties
128: * that do not affect the operation of the component.
129: *
130: * @param propertyId The property identifier.
131: * @param value The value of the property.
132: *
133: * @throws XMLConfigurationException Thrown for configuration error.
134: * In general, components should
135: * only throw this exception if
136: * it is <strong>really</strong>
137: * a critical error.
138: */
139: public void setProperty(String propertyId, Object value)
140: throws XMLConfigurationException;
141:
142: /**
143: * Returns the default state for a feature, or null if this
144: * component does not want to report a default value for this
145: * feature.
146: *
147: * @param featureId The feature identifier.
148: *
149: * @since Xerces 2.2.0
150: */
151: public Boolean getFeatureDefault(String featureId);
152:
153: /**
154: * Returns the default state for a property, or null if this
155: * component does not want to report a default value for this
156: * property.
157: *
158: * @param propertyId The property identifier.
159: *
160: * @since Xerces 2.2.0
161: */
162: public Object getPropertyDefault(String propertyId);
163:
164: } // interface XMLComponent
|