com.webmethods.caf.faces.portlet

Class PortletLifecycleFactory

java.lang.Object

javax.faces.lifecycle.LifecycleFactory

com.webmethods.caf.faces.portlet.PortletLifecycleFactory

All Implemented Interfaces:

FacesWrapper<LifecycleFactory>

public class PortletLifecycleFactory
extends LifecycleFactory

PortletLifecycleFactory is a factory object that creates (if needed) and returns PortletLifecycle instances.

Field Summary

Fields inherited from class javax.faces.lifecycle.LifecycleFactory

DEFAULT_LIFECYCLE

Constructor Summary

Constructors

Constructor and Description
PortletLifecycleFactory()

Method Summary

Modifier and Type	Method and Description
void	addLifecycle(String lifecycleId, Lifecycle lifecycle) Register a new PortletLifecycle instance, associated with the specified lifecycleId, to be supported by this PortletLifecycleFactory.
Lifecycle	getLifecycle(String lifecycleId) Create (if needed) and return a PortletLifecycle instance for the specified lifecycle identifier.
Iterator<String>	getLifecycleIds() Return an Iterator over the set of lifecycle identifiers supported by this factory.

Methods inherited from class javax.faces.lifecycle.LifecycleFactory

getWrapped

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletLifecycleFactory

public PortletLifecycleFactory()

Method Detail

addLifecycle

public void addLifecycle(String lifecycleId,
                         Lifecycle lifecycle)

Register a new PortletLifecycle instance, associated with the specified lifecycleId, to be supported by this PortletLifecycleFactory. This method may be called at any time, and makes the corresponding PortletLifecycle instance available throughout the remaining lifetime of the application.

Specified by:

addLifecycle in class LifecycleFactory

Parameters:

lifecycleId - Identifier of the new PortletLifecycle

lifecycle - PortletLifecycle instance that we are registering

Throws:

IllegalArgumentException - if a PortletLifecycle with the specified lifecycleId has already been registered

NullPointerException - if lifecycleId or lifecycle is null

getLifecycle

public Lifecycle getLifecycle(String lifecycleId)

Create (if needed) and return a PortletLifecycle 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 application, returns the same PortletLifecycle instance.

Specified by:

getLifecycle in class LifecycleFactory

Parameters:

lifecycleId - Lifecycle identifier of the requested PortletLifecycle instance

Throws:

IllegalArgumentException - if no PortletLifecycle instance can be returned for the specified identifier

NullPointerException - if lifecycleId is null

getLifecycleIds

public Iterator<String> getLifecycleIds()

Return an Iterator over the set of lifecycle identifiers supported by this factory.

Specified by:

getLifecycleIds in class LifecycleFactory

Returns:

an Iterator