|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.lifecycle.LifecycleFactory
public abstract class 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 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 JavaServer Faces. This instance can be
acquired, in a portable manner, by calling:
LifecycleFactory factory = (LifecycleFactory)
FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY);
| Field Summary | |
|---|---|
static java.lang.String |
DEFAULT_LIFECYCLE
The lifecycle identifier for the default Lifecycle instance
for this JavaServer Faces implementation. |
| Constructor Summary | |
|---|---|
LifecycleFactory()
|
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String DEFAULT_LIFECYCLE
The lifecycle identifier for the default Lifecycle instance
for this JavaServer Faces implementation.
| Constructor Detail |
|---|
public LifecycleFactory()
| Method Detail |
|---|
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.
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 registering
java.lang.IllegalArgumentException - if a Lifecycle with the
specified lifecycleId has already been registered
java.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.
lifecycleId - Lifecycle identifier of the requested
Lifecycle instance
java.lang.IllegalArgumentException - if no Lifecycle instance
can be returned for the specified identifier
java.lang.NullPointerException - if lifecycleId
is nullpublic 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.
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24