public abstract class FlashFactory extends java.lang.Object implements FacesWrapper<FlashFactory>
FlashFactory is a
factory object that creates (if needed) and returns Flash
instances. Implementations of Jakarta Server Faces must provide at
least a default implementation of Flash
.
There must be one FlashFactory
instance per web
application that is utilizing Jakarta Server 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.
Constructor and 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. |
Modifier and Type | Method and Description |
---|---|
abstract Flash |
getFlash(boolean create)
Create (if needed) and return a
|
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. |
@Deprecated public 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.
wrapped
- The implementation being wrapped.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.
getWrapped
in interface FacesWrapper<FlashFactory>
public abstract Flash getFlash(boolean create)
Create (if needed) and return a
Flash
instance for this web application.
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
.Flash
.