Module jakarta.faces

Package jakarta.faces.context

Class PartialViewContextFactory

java.lang.Object

jakarta.faces.context.PartialViewContextFactory

All Implemented Interfaces:

FacesWrapper<PartialViewContextFactory>

Direct Known Subclasses:

PartialViewContextFactoryImpl

public abstract class PartialViewContextFactory
extends Object
implements FacesWrapper<PartialViewContextFactory>

PartialViewContextFactory is a factory object that creates (if needed) and returns new PartialViewContext instances.

There must be one PartialViewContextFactory instance per web application that is utilizing Jakarta Server Faces. This instance can be acquired, in a portable manner, by calling:

 PartialViewContextFactory factory = (PartialViewContextFactory) FactoryFinder.getFactory(FactoryFinder.PARTIAL_VIEW_CONTEXT_FACTORY);
 

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

Since:

2.0

Constructor Summary

Constructors

Constructor	Description
PartialViewContextFactory()	Deprecated. Use the other constructor taking the implementation being wrapped.
PartialViewContextFactory(PartialViewContextFactory wrapped)	If this 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
abstract PartialViewContext	getPartialViewContext(FacesContext context)	Create (if needed) and return a PartialViewContext instance that is initialized using the current FacesContext instance.
PartialViewContextFactory	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

Constructor Details

PartialViewContextFactory

@Deprecated
public PartialViewContextFactory()

Deprecated.

Use the other constructor taking the implementation being wrapped.

PartialViewContextFactory

public PartialViewContextFactory(PartialViewContextFactory wrapped)

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

Method Details

getWrapped

public PartialViewContextFactory getWrapped()

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Specified by:

getWrapped in interface FacesWrapper<PartialViewContextFactory>

Returns:

the wrapped instance.

getPartialViewContext

public abstract PartialViewContext getPartialViewContext(FacesContext context)

Create (if needed) and return a PartialViewContext instance that is initialized using the current FacesContext instance.

Parameters:

context - the FacesContext for the current request.

Returns:

the PartialViewContext as specified above