All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.faces.context.FlashFactory Maven / Gradle / Ivy

Go to download

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

There is a newer version: 2.4.0
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 * 
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 * 
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 * 
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.

 */
package javax.faces.context;

import javax.faces.FacesWrapper;

/**
 * 

FlashFactory is a * factory object that creates (if needed) and returns {@link Flash} * instances. Implementations of JavaServer Faces must provide at * least a default implementation of {@link Flash}.

*
* *

There must be one {@link FlashFactory} instance per web * application that is utilizing JavaServer Faces. This instance can * be acquired, in a portable manner, by calling:

*
 *   FlashFactory factory = (FlashFactory)
 *     FactoryFinder.getFactory(FactoryFinder.FLASH_FACTORY);
 * 
*

The common way to access the flash instance from Java code is * still via {@link ExternalContext#getFlash}. The common way to access * the flash from Faces views is the implicit EL object "flash". The * runtime must ensure that the FlashFactory is used to * instantiate the flash.

*
* * @since 2.2 */ public abstract class FlashFactory implements FacesWrapper { public FlashFactory() { } /** *

If this factory has been decorated, the * implementation doing the decorating may override this method to provide * access to the implementation being wrapped. A default implementation * is provided that returns null.

* * @since 2.2 */ public FlashFactory getWrapped() { return null; } /** *

Create (if needed) and return a * {@link Flash} instance for this web application.

* * @param create true to create a new instance for this request if * necessary; false to return null if there's no * instance in the current session. * * @since 2.2 */ public abstract Flash getFlash(boolean create); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy