org.apache.myfaces.config.element.FacesConfigData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of myfaces-impl Show documentation
The private implementation classes of the Apache MyFaces Core JSF-2.0 Implementation
There is a newer version: 4.1.0-RC2
/*
 * 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.element;

import java.io.Serializable;
import java.util.Collection;

import javax.el.ELResolver;


/**
 * 
 * @author Leonardo Uribe
 * @since 2.0.3
 */
public abstract class FacesConfigData implements Serializable
{

    /**
     * 
     */
    private static final long serialVersionUID = -5278120443255410184L;

    /** @return Iterator over ApplicationFactory class names */
    public abstract Collection getApplicationFactoryIterator();
    
    /** @return Iterator over ExceptionHandlerFactory class names */
    public abstract Collection getExceptionHandlerFactoryIterator();

    /** @return Iterator over ExternalContextFactory class names */
    public abstract Collection getExternalContextFactoryIterator();

    /** @return Iterator over FacesContextFactory class names */
    public abstract Collection getFacesContextFactoryIterator();

    /** @return Iterator over LifecycleFactory class names */
    public abstract Collection getLifecycleFactoryIterator();

    /** @return Iterator over ViewDeclarationLanguageFactory class names */
    public abstract Collection getViewDeclarationLanguageFactoryIterator();

    /** @return Iterator over PartialViewContextFactory class names */
    public abstract Collection getPartialViewContextFactoryIterator();

    /** @return Iterator over RenderKit factory class names */
    public abstract Collection getRenderKitFactoryIterator();
    
    /** @return Iterator over TagHandlerDelegateFactory factory class names */
    public abstract Collection getTagHandlerDelegateFactoryIterator();

    /** @return Iterator over VisitContextFactory factory class names */
    public abstract Collection getVisitContextFactoryIterator();

    /** @return Iterator over ActionListener class names (in reverse order!) */
    public abstract Collection getActionListenerIterator();

    /** @return the default render kit id */
    public abstract String getDefaultRenderKitId();

    /** @return Iterator over message bundle names (in reverse order!) */
    public abstract String getMessageBundle();

    /** @return Iterator over NavigationHandler class names */
    public abstract Collection getNavigationHandlerIterator();

    /** @return Iterator over ViewHandler class names */
    public abstract Collection getViewHandlerIterator();

    /** @return Iterator over StateManager class names*/
    public abstract Collection getStateManagerIterator();
    
    /** @return Iterator over ResourceHandler class names*/
    public abstract Collection getResourceHandlerIterator();

    /** @return Iterator over PropertyResolver class names */
    public abstract Collection getPropertyResolverIterator();

    /** @return Iterator over VariableResolver class names  */
    public abstract Collection getVariableResolverIterator();

    /** @return the default locale name */
    public abstract String getDefaultLocale();

    /** @return Iterator over supported locale names */
    public abstract Collection getSupportedLocalesIterator();


    /** @return Iterator over all defined component types */
    public abstract Collection getComponentTypes();

    /** @return component class that belongs to the given component type */
    public abstract String getComponentClass(String componentType);


    /** @return Iterator over all defined converter ids */
    public abstract Collection getConverterIds();

    /** @return Iterator over all classes with an associated converter  */
    public abstract Collection getConverterClasses();

    /** @return Iterator over the config classes for the converters  */
    public abstract Collection getConverterConfigurationByClassName();

    /** delivers a converter-configuration for one class-name */
    public abstract Converter getConverterConfiguration(String converterClassName);

    /** @return converter class that belongs to the given converter id */
    public abstract String getConverterClassById(String converterId);

    /** @return converter class that is associated with the given class name  */
    public abstract String getConverterClassByClass(String className);


    /** @return Iterator over all defined validator ids */
    public abstract Collection getValidatorIds();

    /** @return validator class name that belongs to the given validator id */
    public abstract String getValidatorClass(String validatorId);


    /**
     * @return Iterator over {@link org.apache.myfaces.config.element.ManagedBean ManagedBean}s
     */
    public abstract Collection getManagedBeans();

    /**
     * @return Iterator over {@link org.apache.myfaces.config.element.NavigationRule NavigationRule}s
     */
    public abstract Collection getNavigationRules();



    /** @return Iterator over all defined renderkit ids */
    public abstract Collection getRenderKitIds();

    /** @return renderkit class name for given renderkit id */
    public abstract Collection getRenderKitClasses(String renderKitId);

    /**
     * @return Iterator over {@link org.apache.myfaces.config.element.ClientBehaviorRenderer ClientBehaviorRenderer}s for the given renderKitId
     */
    public abstract Collection getClientBehaviorRenderers (String renderKitId);
    
    /**
     * @return Iterator over {@link org.apache.myfaces.config.element.Renderer Renderer}s for the given renderKitId
     */
    public abstract Collection getRenderers(String renderKitId);


    /**
     * @return Iterator over {@link javax.faces.event.PhaseListener} implementation class names
     */
    public abstract Collection getLifecyclePhaseListeners();

    /**
     * @return Iterator over {@link ResourceBundle}
     */
    public abstract Collection getResourceBundles();

    /**
     * @return Iterator over {@link ELResolver} implementation class names
     */
    public abstract Collection getElResolvers();
    
    /**
     * @return Iterator over (@link SystemEventListener) implementation class names 
     */
    public abstract Collection getSystemEventListeners();
    
    /**
     * @return Collection over behaviors
     */
    public abstract Collection getBehaviors ();
    
    /**
     * @return Collection over all defined default validator ids
     */
    public abstract Collection getDefaultValidatorIds ();
    
    /**
     * @return the partial traversal class name
     */
    public abstract String getPartialTraversal ();
    
    /**
     * @return Faces application version.
     */
    public abstract String getFacesVersion ();
    
    /**
     * 
     * @return
     */
    public abstract Collection getNamedEvents();

}