Package jakarta.faces.flow

Class FlowHandlerFactoryWrapper

java.lang.Object

jakarta.faces.flow.FlowHandlerFactory

jakarta.faces.flow.FlowHandlerFactoryWrapper

All Implemented Interfaces:

FacesWrapper<FlowHandlerFactory>

public abstract class FlowHandlerFactoryWrapper
extends FlowHandlerFactory
implements FacesWrapper<FlowHandlerFactory>

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

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
FlowHandlerFactoryWrapper()	Deprecated. Use the other constructor taking the implementation being wrapped.
FlowHandlerFactoryWrapper(FlowHandlerFactory wrapped)	If this flow handler factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and Type	Method	Description
FlowHandler	createFlowHandler(FacesContext context)	Create the singleton instance of FlowHandler.
FlowHandlerFactory	getWrapped()	A class that implements this interface uses this method to return an instance of the class being wrapped.

Methods inherited from class java.lang.Object

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

Constructor Details

FlowHandlerFactoryWrapper

@Deprecated public FlowHandlerFactoryWrapper()

Deprecated.

Use the other constructor taking the implementation being wrapped.

FlowHandlerFactoryWrapper

public FlowHandlerFactoryWrapper(FlowHandlerFactory wrapped)

If this flow handler 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.

Parameters:

wrapped - The implementation being wrapped.

Since:

2.3

Method Details

getWrapped

public FlowHandlerFactory getWrapped()

Description copied from interface: FacesWrapper

A class that implements this interface uses this method to return an instance of the class being wrapped.

Specified by:

getWrapped in interface FacesWrapper<FlowHandlerFactory>

Returns:

the wrapped instance.

createFlowHandler

public FlowHandler createFlowHandler(FacesContext context)

Description copied from class: FlowHandlerFactory

Create the singleton instance of FlowHandler.

Specified by:

createFlowHandler in class FlowHandlerFactory

Parameters:

context - the FacesContext for the current request

Returns:

the newly created FlowHandler