Package jakarta.faces.lifecycle

Class LifecycleWrapper

java.lang.Object
jakarta.faces.lifecycle.Lifecycle
jakarta.faces.lifecycle.LifecycleWrapper
All Implemented Interfaces:
FacesWrapper<Lifecycle>
public abstract class LifecycleWrapper extends Lifecycle implements FacesWrapper<Lifecycle>

Provides a simple implementation of Lifecycle that can be subclassed by developers wishing to provide specialized behavior to an existing Lifecycle instance. The default implementation of all methods is to call through to the wrapped Lifecycle.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped() to access the instance being wrapped.

Since:
2.2

  • Constructor Summary

    Constructors
    Constructor
    Description
    LifecycleWrapper()
    Deprecated.
    Use the other constructor taking the implementation being wrapped.
    LifecycleWrapper(Lifecycle wrapped)
    If this lifecycle has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPhaseListener(PhaseListener listener)
    Register a new PhaseListener instance that is interested in being notified before and after the processing for standard phases of the request processing lifecycle.
    void
    attachWindow(FacesContext context)
    Create or restore the ClientWindow to be used to display the UIViewRoot for this run through the lifecycle.
    void
    execute(FacesContext context)
    Execute all of the phases of the request processing lifecycle, up to but not including the Render Response phase, as described in the Jakarta Server Faces Specification, in the specified order.
    PhaseListener[]
    getPhaseListeners()
    Return the set of registered PhaseListeners for this Lifecycle instance.
    Lifecycle
    getWrapped()
    A class that implements this interface uses this method to return an instance of the class being wrapped.
    void
    removePhaseListener(PhaseListener listener)
    Deregister an existing PhaseListener instance that is no longer interested in being notified before and after the processing for standard phases of the request processing lifecycle.
    void
    render(FacesContext context)
    Execute the Render Response phase of the request processing lifecycle, unless the responseComplete() method has been called on the FacesContext instance associated with the current request.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LifecycleWrapper

      @Deprecated public LifecycleWrapper()
      Deprecated.
      Use the other constructor taking the implementation being wrapped.

    • LifecycleWrapper

      public LifecycleWrapper(Lifecycle wrapped)

      If this lifecycle 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.

      Parameters:
      wrapped - The implementation being wrapped.
      Since:
      2.3

  • Method Details