XMLComponent


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    *
5    * Copyright (c) 2000-2002 The Apache Software Foundation.  
6    * All rights reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer. 
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution,
21   *    if any, must include the following acknowledgment:  
22   *       "This product includes software developed by the
23   *        Apache Software Foundation (http://www.apache.org/)."
24   *    Alternately, this acknowledgment may appear in the software itself,
25   *    if and wherever such third-party acknowledgments normally appear.
26   *
27   * 4. The names "Xerces" and "Apache Software Foundation" must
28   *    not be used to endorse or promote products derived from this
29   *    software without prior written permission. For written 
30   *    permission, please contact apache@apache.org.
31   *
32   * 5. Products derived from this software may not be called "Apache",
33   *    nor may "Apache" appear in their name, without prior written
34   *    permission of the Apache Software Foundation.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the Apache Software Foundation and was
52   * originally based on software copyright (c) 1999, International
53   * Business Machines, Inc., http://www.apache.org.  For more
54   * information on the Apache Software Foundation, please see
55   * <http://www.apache.org/>.
56   */
57  
58  package com.sun.org.apache.xerces.internal.xni.parser;
59  
60  /**
61   * The component interface defines methods that must be implemented
62   * by components in a parser configuration. The component methods allow
63   * the component manager to initialize the component state and notify
64   * the component when feature and property values change.
65   *
66   * @see XMLComponentManager
67   *
68   * @author Andy Clark, IBM
69   *
70   * @version $Id: XMLComponent.java,v 1.5 2002/09/24 09:39:45 andyc Exp $
71   */
72  public interface XMLComponent {
73  
74      //
75      // XMLComponent methods
76      //
77  
78      /**
79       * Resets the component. The component can query the component manager
80       * about any features and properties that affect the operation of the
81       * component.
82       * 
83       * @param componentManager The component manager.
84       *
85       * @throws XNIException Thrown by component on initialization error.
86       */
87      public void reset(XMLComponentManager componentManager) 
88          throws XMLConfigurationException;
89  
90      /**
91       * Returns a list of feature identifiers that are recognized by
92       * this component. This method may return null if no features
93       * are recognized by this component.
94       */
95      public String  [] getRecognizedFeatures();
96  
97      /**
98       * Sets the state of a feature. This method is called by the component
99       * 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
165
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags