public abstract class LifecycleFactory extends java.lang.Object implements FacesWrapper<LifecycleFactory>
LifecycleFactory is a factory object that creates
(if needed) and returns Lifecycle instances. Implementations of Jakarta Faces must provide at least a
default implementation of Lifecycle. Advanced implementations (or external third party libraries) MAY provide
additional Lifecycle implementations (keyed by lifecycle identifiers) for performing different types of
request processing on a per-request basis.
There must be one LifecycleFactory instance per web application that is utilizing Jakarta Faces.
This instance can be acquired, in a portable manner, by calling:
LifecycleFactory factory = (LifecycleFactory) FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY);
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped() to
access the instance being wrapped.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_LIFECYCLE
The lifecycle identifier for the default
Lifecycle instance for this Jakarta Faces implementation. |
| Constructor and Description |
|---|
LifecycleFactory()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
LifecycleFactory(LifecycleFactory 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 void |
addLifecycle(java.lang.String lifecycleId,
Lifecycle lifecycle)
Register a new
Lifecycle instance, associated with the specified lifecycleId, to be supported by
this LifecycleFactory. |
abstract Lifecycle |
getLifecycle(java.lang.String lifecycleId)
Create (if needed) and return a
Lifecycle instance for the specified lifecycle identifier. |
abstract java.util.Iterator<java.lang.String> |
getLifecycleIds()
Return an
Iterator over the set of lifecycle identifiers supported by this factory. |
LifecycleFactory |
getWrapped()
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. |
public static final java.lang.String DEFAULT_LIFECYCLE
The lifecycle identifier for the default Lifecycle instance for this Jakarta Faces implementation.
@Deprecated public LifecycleFactory()
public LifecycleFactory(LifecycleFactory 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 LifecycleFactory 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<LifecycleFactory>public abstract void addLifecycle(java.lang.String lifecycleId,
Lifecycle lifecycle)
Register a new Lifecycle instance, associated with the specified lifecycleId, to be supported by
this LifecycleFactory. This method may be called at any time, and makes the corresponding
Lifecycle instance available throughout the remaining lifetime of this web application.
lifecycleId - Identifier of the new Lifecyclelifecycle - Lifecycle instance that we are registeringjava.lang.IllegalArgumentException - if a Lifecycle with the specified lifecycleId has already been
registeredjava.lang.NullPointerException - if lifecycleId or lifecycle is nullpublic abstract Lifecycle getLifecycle(java.lang.String lifecycleId)
Create (if needed) and return a Lifecycle instance for the specified lifecycle identifier. The set of
available lifecycle identifiers is available via the getLifecycleIds() method.
Each call to getLifecycle() for the same lifecycleId, from within the same web application,
must return the same Lifecycle instance.
public abstract java.util.Iterator<java.lang.String> getLifecycleIds()
Return an Iterator over the set of lifecycle identifiers supported by this factory. This set must
include the value specified by LifecycleFactory.DEFAULT_LIFECYCLE.
Iterator over the set of lifecycle identifiers supported by this factory