Top Description Fields Constructors Methods
jakarta.faces.component.search

public abstract Class SearchExpressionContextFactory

extends Object
implements FacesWrapper<SearchExpressionContextFactory>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Imports
java.util.Set, jakarta.faces.FacesWrapper, jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitHint, jakarta.faces.context.FacesContext

Provide for separation of interface and implementation for the SearchExpressionContext 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.3

Field Summary

Modifier and TypeField and Description
private final SearchExpressionContextFactory
wrapped

Constructor Summary

AccessConstructor and Description
public
SearchExpressionContextFactory(SearchExpressionContextFactory
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 SearchExpressionContext

Returns:

a SearchExpressionContext instance
getSearchExpressionContext(FacesContext
the FacesContext for the current request
context, UIComponent
the source / base component from which we will start to perform our search.
source, Set<SearchExpressionHint>
the SearchExpressionHint to apply to the search. If null, no hints are applied.
expressionHints, Set<VisitHint>
the VisitHints to apply to the visit, if used by a SearchKeywordResolver. If null, no hints are applied.
visitHints)

Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.

public SearchExpressionContextFactory
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 final SearchExpressionContextFactory wrapped

Constructor Detail

SearchExpressionContextFactoryback to summary
public SearchExpressionContextFactory(SearchExpressionContextFactory 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:SearchExpressionContextFactory

The implementation being wrapped.

Method Detail

getSearchExpressionContextback to summary
public abstract SearchExpressionContext getSearchExpressionContext(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)

Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.

Parameters
context:FacesContext

the FacesContext for the current request

source:UIComponent

the source / base component from which we will start to perform our search.

expressionHints:Set<SearchExpressionHint>

the SearchExpressionHint to apply to the search. If null, no hints are applied.

visitHints:Set<VisitHint>

the VisitHints to apply to the visit, if used by a SearchKeywordResolver. If null, no hints are applied.

Returns:SearchExpressionContext

a SearchExpressionContext instance

Since
2.3
getWrappedback to summary
public SearchExpressionContextFactory 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:SearchExpressionContextFactory

Doc from jakarta.faces.FacesWrapper.getWrapped.

the wrapped instance.

Annotations
@Override