javax.faces.application.ApplicationFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsf-api

This is the master POM file for Oracle's Implementation of the JSF 2.1 Specification.

There is a newer version: 2.1

/*
 * $Id: ApplicationFactory.java,v 1.7 2005/12/05 16:42:41 edburns Exp $
 */

/*
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 * 
 * You can obtain a copy of the License at
 * https://javaserverfaces.dev.java.net/CDDL.html or
 * legal/CDDLv1.0.txt. 
 * See the License for the specific language governing
 * permission and limitations under the License.
 * 
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at legal/CDDLv1.0.txt.    
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * [Name of File] [ver.__] [Date]
 * 
 * Copyright 2005 Sun Microsystems Inc. All Rights Reserved
 */

package javax.faces.application;


/**
 * ApplicationFactory is a factory object that creates
 * (if needed) and returns {@link Application} instances.  Implementations of
 * JavaServer Faces must provide at least a default implementation of
 * {@link Application}.
 *
 * There must be one {@link ApplicationFactory} instance per web
 * application that is utilizing JavaServer Faces.  This instance can be
 * acquired, in a portable manner, by calling:
 *  *   ApplicationFactory factory = (ApplicationFactory)
 *    FactoryFinder.getFactory(FactoryFinder.APPLICATION_FACTORY);
 * 
 */

public abstract class ApplicationFactory {


    /**
     * Create (if needed) and return an {@link Application} instance
     * for this web application.
     */
    public abstract Application getApplication();


    /**
     * Replace the {@link Application} instance that will be
     * returned for this web application.
     *
     * @throws NullPointerException if application
     *  is null.

     * @param application The replacement {@link Application} instance
     */
    public abstract void setApplication(Application application);


}