Class LifecycleFactory
- java.lang.Object
-
- javax.faces.lifecycle.LifecycleFactory
-
- All Implemented Interfaces:
FacesWrapper<LifecycleFactory>
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 JavaServer Faces must provide at least a default implementation ofLifecycle
. Advanced implementations (or external third party libraries) MAY provide additionalLifecycle
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 JavaServer Faces. This instance can be acquired, in a portable manner, by calling:LifecycleFactory factory = (LifecycleFactory) FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY);
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_LIFECYCLE
The lifecycle identifier for the defaultLifecycle
instance for this JavaServer Faces implementation.
-
Constructor Summary
Constructors Constructor Description LifecycleFactory()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
addLifecycle(java.lang.String lifecycleId, Lifecycle lifecycle)
Register a newLifecycle
instance, associated with the specifiedlifecycleId
, to be supported by thisLifecycleFactory
.abstract Lifecycle
getLifecycle(java.lang.String lifecycleId)
Create (if needed) and return aLifecycle
instance for the specified lifecycle identifier.abstract java.util.Iterator<java.lang.String>
getLifecycleIds()
Return anIterator
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.
-
-
-
Field Detail
-
DEFAULT_LIFECYCLE
public static final java.lang.String DEFAULT_LIFECYCLE
The lifecycle identifier for the default
Lifecycle
instance for this JavaServer Faces implementation.- See Also:
- Constant Field Values
-
-
Method Detail
-
getWrapped
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. A default implementation is provided that returns
null
.- Specified by:
getWrapped
in interfaceFacesWrapper<LifecycleFactory>
- Since:
- 2.0
-
addLifecycle
public abstract void addLifecycle(java.lang.String lifecycleId, Lifecycle lifecycle)
Register a new
Lifecycle
instance, associated with the specifiedlifecycleId
, to be supported by thisLifecycleFactory
. This method may be called at any time, and makes the correspondingLifecycle
instance available throughout the remaining lifetime of this web application.- Parameters:
lifecycleId
- Identifier of the newLifecycle
lifecycle
-Lifecycle
instance that we are registering- Throws:
java.lang.IllegalArgumentException
- if aLifecycle
with the specifiedlifecycleId
has already been registeredjava.lang.NullPointerException
- iflifecycleId
orlifecycle
isnull
-
getLifecycle
public 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 thegetLifecycleIds()
method.Each call to
getLifecycle()
for the samelifecycleId
, from within the same web application, must return the sameLifecycle
instance.
-
getLifecycleIds
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 byLifecycleFactory.DEFAULT_LIFECYCLE
.
-
-