Top Description Fields Constructors Methods
jakarta.faces.context

public abstract Class PartialViewContextFactory

extends Object
implements FacesWrapper<PartialViewContextFactory>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Imports
jakarta.faces.FacesWrapper

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

Field Summary

Modifier and TypeField and Description
private PartialViewContextFactory
wrapped

Constructor Summary

AccessConstructor and Description
public
PartialViewContextFactory()

Deprecated Use the other constructor taking the implementation being wrapped.
public
PartialViewContextFactory(PartialViewContextFactory
The implementation being wrapped.
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 TypeMethod and Description
public abstract PartialViewContext

Returns:

the PartialViewContext as specified above
getPartialViewContext(FacesContext
the FacesContext for the current request.
context)

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

public PartialViewContextFactory
getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrappedback to summary
private PartialViewContextFactory wrapped

Constructor Detail

PartialViewContextFactoryback to summary
public PartialViewContextFactory()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
PartialViewContextFactoryback to summary
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:PartialViewContextFactory

The implementation being wrapped.

Method Detail

getPartialViewContextback to summary
public abstract PartialViewContext getPartialViewContext(FacesContext context)

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

Parameters
context:FacesContext

the FacesContext for the current request.

Returns:PartialViewContext

the PartialViewContext as specified above

getWrappedback to summary
public PartialViewContextFactory getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

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

Returns:PartialViewContextFactory

Doc from jakarta.faces.FacesWrapper.getWrapped.

the wrapped instance.

Annotations
@Override