Package jakarta.faces.component.visit

Class VisitContextFactory

java.lang.Object

jakarta.faces.component.visit.VisitContextFactory

All Implemented Interfaces:

FacesWrapper<VisitContextFactory>

public abstract class VisitContextFactory
extends Object
implements FacesWrapper<VisitContextFactory>

Provide for separation of interface and implementation for the VisitContext contract.

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
VisitContextFactory()	Deprecated. Use the other constructor taking the implementation being wrapped.
VisitContextFactory(VisitContextFactory 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 VisitContext	getVisitContext(FacesContext context, Collection<String> ids, Set<VisitHint> hints)	Return a new VisitContext instance.
VisitContextFactory	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 Detail

VisitContextFactory

@Deprecated
public VisitContextFactory()

Deprecated.

Use the other constructor taking the implementation being wrapped.

VisitContextFactory

public VisitContextFactory(VisitContextFactory 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 Detail

getWrapped

public VisitContextFactory 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<VisitContextFactory>

Returns:

the wrapped instance.

getVisitContext

public abstract VisitContext getVisitContext(FacesContext context,
                                             Collection<String> ids,
                                             Set<VisitHint> hints)

Return a new VisitContext instance.

Parameters:

context - the FacesContext for this request.

ids - a Collection of clientIds to visit. If null all components will be visited.

hints - the VisitHints that apply to this visit.

Returns:

the instance of VisitContext.

Since:

2.0