/*

  * Licensed to the Apache Software Foundation (ASF) under one

  * or more contributor license agreements.  See the NOTICE file

  * distributed with this work for additional information

  * regarding copyright ownership.  The ASF licenses this file

  * to you under the Apache License, Version 2.0 (the

  * "License"); you may not use this file except in compliance

  * with the License.  You may obtain a copy of the License at

  *

  *   http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an

  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  * KIND, either express or implied.  See the License for the

  * specific language governing permissions and limitations

  * under the License.

  */

 package org.apache.myfaces.config;

 import org.apache.myfaces.config.element.ManagedBean;

 import org.apache.myfaces.config.element.NavigationRule;

 import org.apache.myfaces.config.element.Renderer;

 import org.apache.myfaces.config.impl.digester.elements.Converter;

 import org.apache.myfaces.config.impl.digester.elements.ResourceBundle;

 import javax.el.ELResolver;

 import java.util.Iterator;

 /**

  * Subsumes several unmarshalled faces config objects and presents a simple interface

  * to the combined configuration data.

  *

  * @author Manfred Geiler (latest modification by $Author: skitching $)

  * @version $Revision: 684459 $ $Date: 2008-08-10 06:13:56 -0500 (Sun, 10 Aug 2008) $

  */

 public interface FacesConfigDispenser<C>

 {

     /**

      * Add another unmarshalled faces config object.

      * @param facesConfig unmarshalled faces config object

      */

     public void feed(C facesConfig);

     /**

      * Add another ApplicationFactory class name

      * @param factoryClassName a class name

      */

     public void feedApplicationFactory(String factoryClassName);

     /**

      * Add another FacesContextFactory class name

      * @param factoryClassName a class name

      */

     public void feedFacesContextFactory(String factoryClassName);

     /**

      * Add another LifecycleFactory class name

      * @param factoryClassName a class name

      */

     public void feedLifecycleFactory(String factoryClassName);

     /**

      * Add another RenderKitFactory class name

      * @param factoryClassName a class name

      */

     public void feedRenderKitFactory(String factoryClassName);

     /** @return Iterator over ApplicationFactory class names */

     public Iterator<String> getApplicationFactoryIterator();

     /** @return Iterator over FacesContextFactory class names */

     public Iterator<String> getFacesContextFactoryIterator();

     /** @return Iterator over LifecycleFactory class names */

     public Iterator<String> getLifecycleFactoryIterator();

     /** @return Iterator over RenderKit factory class names */

     public Iterator<String> getRenderKitFactoryIterator();

     /** @return Iterator over ActionListener class names (in reverse order!) */

     public Iterator<String> getActionListenerIterator();

     /** @return the default render kit id */

     public String getDefaultRenderKitId();

     /** @return Iterator over message bundle names (in reverse order!) */

     public String getMessageBundle();

     /** @return Iterator over NavigationHandler class names */

     public Iterator<String> getNavigationHandlerIterator();

     /** @return Iterator over ViewHandler class names */

     public Iterator<String> getViewHandlerIterator();

     /** @return Iterator over StateManager class names*/

     public Iterator getStateManagerIterator();

     /** @return Iterator over PropertyResolver class names */

     public Iterator<String> getPropertyResolverIterator();

     /** @return Iterator over VariableResolver class names  */

     public Iterator<String> getVariableResolverIterator();

     /** @return the default locale name */

     public String getDefaultLocale();

     /** @return Iterator over supported locale names */

     public Iterator<String> getSupportedLocalesIterator();

     /** @return Iterator over all defined component types */

     public Iterator<String> getComponentTypes();

     /** @return component class that belongs to the given component type */

     public String getComponentClass(String componentType);

     /** @return Iterator over all defined converter ids */

     public Iterator<String> getConverterIds();

     /** @return Iterator over all classes with an associated converter  */

     public Iterator<String> getConverterClasses();

     /** @return Iterator over the config classes for the converters  */

     Iterator<String> getConverterConfigurationByClassName();

     /** delivers a converter-configuration for one class-name */

     Converter getConverterConfiguration(String converterClassName);

     /** @return converter class that belongs to the given converter id */

     public String getConverterClassById(String converterId);

     /** @return converter class that is associated with the given class name  */

     public String getConverterClassByClass(String className);

     /** @return Iterator over all defined validator ids */

     public Iterator<String> getValidatorIds();

     /** @return validator class name that belongs to the given validator id */

     public String getValidatorClass(String validatorId);

     /**

      * @return Iterator over {@link org.apache.myfaces.config.element.ManagedBean ManagedBean}s

      */

     public Iterator<ManagedBean> getManagedBeans();

     /**

      * @return Iterator over {@link org.apache.myfaces.config.element.NavigationRule NavigationRule}s

      */

     public Iterator<NavigationRule> getNavigationRules();

     /** @return Iterator over all defined renderkit ids */

     public Iterator<String> getRenderKitIds();

     /** @return renderkit class name for given renderkit id */

     public String getRenderKitClass(String renderKitId);

     /**

      * @return Iterator over {@link org.apache.myfaces.config.element.Renderer Renderer}s for the given renderKitId

      */

     public Iterator<Renderer> getRenderers(String renderKitId);

     /**

      * @return Iterator over {@link javax.faces.event.PhaseListener} implementation class names

      */

     public Iterator<String> getLifecyclePhaseListeners();

     /**

      * @return Iterator over {@link ResourceBundle}

      */

     public Iterator<ResourceBundle> getResourceBundles();

     /**

      * @return Iterator over {@link ELResolver} implementation class names

      */

     public Iterator<String> getElResolvers();

 }