Top Description Fields Constructors Methods
javax.faces.component.visit

public abstract Class VisitContextFactory

extends Object
implements FacesWrapper<VisitContextFactory>
Class Inheritance
All Implemented Interfaces
javax.faces.FacesWrapper
Imports
java.util.Collection, .Set, javax.faces.FacesWrapper, javax.faces.context.FacesContext

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

Field Summary

Modifier and TypeField and Description
private VisitContextFactory

Constructor Summary

AccessConstructor and Description
public
VisitContextFactory()

Deprecated Use the other constructor taking the implementation being wrapped.
public
VisitContextFactory(VisitContextFactory
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 VisitContext

Returns:

the instance of VisitContext.
getVisitContext
(FacesContext
the FacesContext for this request.
context
,
Collection<String>
a Collection of clientIds to visit. If null all components will be visited.
ids
,
Set<VisitHint>
the VisitHints that apply to this visit.
hints
)

Return a new VisitContext instance.

public VisitContextFactory
getWrapped()

Implements javax.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 VisitContextFactory wrapped

Constructor Detail

VisitContextFactoryback to summary
public VisitContextFactory()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
VisitContextFactoryback to summary
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:VisitContextFactory

The implementation being wrapped.

Method Detail

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

Return a new VisitContext instance.

Parameters
context:FacesContext

the FacesContext for this request.

ids:Collection<String>

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

hints:Set<VisitHint>

the VisitHints that apply to this visit.

Returns:VisitContext

the instance of VisitContext.

Since
2.0
getWrappedback to summary
public VisitContextFactory getWrapped()

Implements javax.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:VisitContextFactory

Doc from javax.faces.FacesWrapper.getWrapped.

the wrapped instance.

Annotations
@Override