Top Description Fields Constructors Methods
jakarta.faces.context

public abstract Class FlashFactory

extends Object
implements FacesWrapper<FlashFactory>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Known Direct Subclasses
com.sun.faces.context.flash.FlashFactoryImpl
Imports
jakarta.faces.FacesWrapper

FlashFactory is a factory object that creates (if needed) and returns Flash instances. Implementations of Jakarta Faces must provide at least a default implementation of Flash.

There must be one FlashFactory instance per web application that is utilizing Jakarta 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 ExternalContext#getFlash. The common way to access the flash from Faces views is the implicit Jakarta Expression Language object "flash". The runtime must ensure that the FlashFactory is used to instantiate the flash.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.2

Field Summary

Modifier and TypeField and Description
private FlashFactory
wrapped

Constructor Summary

AccessConstructor and Description
public
FlashFactory()
Deprecated Use the other constructor taking the implementation being wrapped.

public
FlashFactory(FlashFactory
The implementation being wrapped.
wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and TypeMethod and Description
public abstract Flash

Returns:

the instance of Flash.
getFlash(boolean
true to create a new instance for this request if necessary; false to return null if there's no instance in the current session.
create)

Create (if needed) and return a Flash instance for this web application.

public FlashFactory
getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrappedback to summary
private FlashFactory wrapped

Constructor Detail

FlashFactoryback to summary
public FlashFactory()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
FlashFactoryback to summary
public FlashFactory(FlashFactory wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters
wrapped:FlashFactory

The implementation being wrapped.

Method Detail

getFlashback to summary
public abstract Flash getFlash(boolean create)

Create (if needed) and return a Flash instance for this web application.

Parameters
create:boolean

true to create a new instance for this request if necessary; false to return null if there's no instance in the current session.

Returns:Flash

the instance of Flash.

Since
2.2
getWrappedback to summary
public FlashFactory getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Returns:FlashFactory

Doc from jakarta.faces.FacesWrapper.getWrapped.

the wrapped instance.

Annotations
@Override