Class FlashFactory
- java.lang.Object
-
- jakarta.faces.context.FlashFactory
-
- All Implemented Interfaces:
FacesWrapper<FlashFactory>
public abstract class FlashFactory extends Object implements FacesWrapper<FlashFactory>
FlashFactory is a factory object that creates (if needed) and returns
Flash
instances. Implementations of Jakarta Faces must provide at least a default implementation ofFlash
.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 theFlashFactory
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
-
-
Constructor Summary
Constructors Constructor Description FlashFactory()
Deprecated.Use the other constructor taking the implementation being wrapped.FlashFactory(FlashFactory wrapped)
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract Flash
getFlash(boolean create)
Create (if needed) and return aFlash
instance for this web application.FlashFactory
getWrapped()
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
-
-
-
Constructor Detail
-
FlashFactory
@Deprecated public FlashFactory()
Deprecated.Use the other constructor taking the implementation being wrapped.
-
FlashFactory
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
- The implementation being wrapped.
-
-
Method Detail
-
getWrapped
public FlashFactory getWrapped()
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<FlashFactory>
- Returns:
- the wrapped instance.
-
getFlash
public abstract Flash getFlash(boolean create)
Create (if needed) and return a
Flash
instance for this web application.- Parameters:
create
-true
to create a new instance for this request if necessary;false
to returnnull
if there's no instance in the currentsession
.- Returns:
- the instance of
Flash
. - Since:
- 2.2
-
-