KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > myfaces > config > FacesConfigDispenser


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.myfaces.config;
17
18 import org.apache.myfaces.config.impl.digester.elements.Converter;
19
20 import java.util.Iterator JavaDoc;
21
22 /**
23  * Subsumes several unmarshalled faces config objects and presents a simple interface
24  * to the combined configuration data.
25  *
26  * @author Manfred Geiler (latest modification by $Author: mmarinschek $)
27  * @version $Revision: 1.3 $ $Date: 2005/03/04 00:28:45 $
28  * $Log: FacesConfigDispenser.java,v $
29  * Revision 1.3 2005/03/04 00:28:45 mmarinschek
30  * Changes in configuration due to missing Attribute/Property classes for the converter; not building in the functionality yet except for part of the converter properties
31  *
32  * Revision 1.2 2004/10/13 11:50:59 matze
33  * renamed packages to org.apache
34  *
35  * Revision 1.1 2004/07/07 00:25:05 o_rossmueller
36  * tidy up config/confignew package (moved confignew classes to package config)
37  *
38  * Revision 1.3 2004/07/01 22:05:09 mwessendorf
39  * ASF switch
40  *
41  * Revision 1.2 2004/06/16 23:02:23 o_rossmueller
42  * merged confignew_branch
43  *
44  * Revision 1.1.2.1 2004/06/16 01:25:52 o_rossmueller
45  * refactorings: FactoryFinder, decorator creation, dispenser (removed reverse order)
46  * bug fixes
47  * additional tests
48  *
49  * Revision 1.1 2004/05/17 14:28:27 manolito
50  * new configuration concept
51  *
52  */
53 public interface FacesConfigDispenser
54 {
55     /**
56      * Add another unmarshalled faces config object.
57      * @param facesConfig unmarshalled faces config object
58      */
59     public void feed(Object JavaDoc facesConfig);
60
61     /**
62      * Add another ApplicationFactory class name
63      * @param factoryClassName a class name
64      */
65     public void feedApplicationFactory(String JavaDoc factoryClassName);
66
67     /**
68      * Add another FacesContextFactory class name
69      * @param factoryClassName a class name
70      */
71     public void feedFacesContextFactory(String JavaDoc factoryClassName);
72
73     /**
74      * Add another LifecycleFactory class name
75      * @param factoryClassName a class name
76      */
77     public void feedLifecycleFactory(String JavaDoc factoryClassName);
78
79     /**
80      * Add another RenderKitFactory class name
81      * @param factoryClassName a class name
82      */
83     public void feedRenderKitFactory(String JavaDoc factoryClassName);
84
85
86
87     /** @return Iterator over ApplicationFactory class names */
88     public Iterator JavaDoc getApplicationFactoryIterator();
89
90     /** @return Iterator over FacesContextFactory class names */
91     public Iterator JavaDoc getFacesContextFactoryIterator();
92
93     /** @return Iterator over LifecycleFactory class names */
94     public Iterator JavaDoc getLifecycleFactoryIterator();
95
96     /** @return Iterator over RenderKit factory class names */
97     public Iterator JavaDoc getRenderKitFactoryIterator();
98
99
100     /** @return Iterator over ActionListener class names (in reverse order!) */
101     public Iterator JavaDoc getActionListenerIterator();
102
103     /** @return the default render kit id */
104     public String JavaDoc getDefaultRenderKitId();
105
106     /** @return Iterator over message bundle names (in reverse order!) */
107     public String JavaDoc getMessageBundle();
108
109     /** @return Iterator over NavigationHandler class names */
110     public Iterator JavaDoc getNavigationHandlerIterator();
111
112     /** @return Iterator over ViewHandler class names */
113     public Iterator JavaDoc getViewHandlerIterator();
114
115     /** @return Iterator over StateManager class names*/
116     public Iterator JavaDoc getStateManagerIterator();
117
118     /** @return Iterator over PropertyResolver class names */
119     public Iterator JavaDoc getPropertyResolverIterator();
120
121     /** @return Iterator over VariableResolver class names */
122     public Iterator JavaDoc getVariableResolverIterator();
123
124     /** @return the default locale name */
125     public String JavaDoc getDefaultLocale();
126
127     /** @return Iterator over supported locale names */
128     public Iterator JavaDoc getSupportedLocalesIterator();
129
130
131     /** @return Iterator over all defined component types */
132     public Iterator JavaDoc getComponentTypes();
133
134     /** @return component class that belongs to the given component type */
135     public String JavaDoc getComponentClass(String JavaDoc componentType);
136
137
138     /** @return Iterator over all defined converter ids */
139     public Iterator JavaDoc getConverterIds();
140
141     /** @return Iterator over all classes with an associated converter */
142     public Iterator JavaDoc getConverterClasses();
143
144     /** @return Iterator over the config classes for the converters */
145     Iterator JavaDoc getConverterConfigurationByClassName();
146
147     /** delivers a converter-configuration for one class-name */
148     Converter getConverterConfiguration(String JavaDoc converterClassName);
149
150     /** @return converter class that belongs to the given converter id */
151     public String JavaDoc getConverterClassById(String JavaDoc converterId);
152
153     /** @return converter class that is associated with the given class name */
154     public String JavaDoc getConverterClassByClass(String JavaDoc className);
155
156
157     /** @return Iterator over all defined validator ids */
158     public Iterator JavaDoc getValidatorIds();
159
160     /** @return validator class name that belongs to the given validator id */
161     public String JavaDoc getValidatorClass(String JavaDoc validatorId);
162
163
164     /**
165      * @return Iterator over {@link org.apache.myfaces.config.element.ManagedBean ManagedBean}s
166      */
167     public Iterator JavaDoc getManagedBeans();
168
169     /**
170      * @return Iterator over {@link org.apache.myfaces.config.element.NavigationRule NavigationRule}s
171      */
172     public Iterator JavaDoc getNavigationRules();
173
174
175
176     /** @return Iterator over all defined renderkit ids */
177     public Iterator JavaDoc getRenderKitIds();
178
179     /** @return renderkit class name for given renderkit id */
180     public String JavaDoc getRenderKitClass(String JavaDoc renderKitId);
181
182     /**
183      * @return Iterator over {@link org.apache.myfaces.config.element.Renderer Renderer}s for the given renderKitId
184      */
185     public Iterator JavaDoc getRenderers(String JavaDoc renderKitId);
186
187
188     /**
189      * @return Iterator over {@link javax.faces.event.PhaseListener} implementation class names
190      */
191     public Iterator JavaDoc getLifecyclePhaseListeners();
192 }
193
Popular Tags