Top Description Constructors Methods
jakarta.faces.component.search

public abstract Class SearchExpressionContext

extends Object
Class Inheritance
Known Direct Subclasses
com.sun.faces.component.search.SearchExpressionContextImpl
Imports
java.util.Set, jakarta.faces.FactoryFinder, jakarta.faces.component.UIComponent, jakarta.faces.component.visit.VisitHint, jakarta.faces.context.FacesContext

A context object that is used to hold state relating to resolve a search expression.

Since
2.3
See Also
SearchExpressionHandler

Constructor Summary

AccessConstructor and Description
public
SearchExpressionContext()

Method Summary

Modifier and TypeMethod and Description
public static SearchExpressionContext

Returns:

a SearchExpressionContext instance
createSearchExpressionContext(FacesContext
the FacesContext for the current request
context, UIComponent
the source / base component from which we will start to perform our search.
source)

Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.

public static SearchExpressionContext

Returns:

a SearchExpressionContext instance
createSearchExpressionContext(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 abstract Set<SearchExpressionHint>

Returns:

a non-empty, unmodifiable collection of SearchExpressionHints
getExpressionHints()

Returns hints that influence the behavior of resolving the expression.

public abstract FacesContext

Returns:

the FacesContext.
getFacesContext()

Returns the FacesContext for the current request.

public abstract UIComponent

Returns:

the source component.
getSource()

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

public abstract Set<VisitHint>

Returns:

a non-empty, unmodifiable collection of VisitHints
getVisitHints()

Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver implementation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

SearchExpressionContextback to summary
public SearchExpressionContext()

Method Detail

createSearchExpressionContextback to summary
public static SearchExpressionContext createSearchExpressionContext(FacesContext context, UIComponent source)

Creates a SearchExpressionContext instance for use with the SearchExpressionHandler. This method can be used to obtain a SearchExpressionContext instance without any VisitHint or SearchExpressionHint.

Parameters
context:FacesContext

the FacesContext for the current request

source:UIComponent

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

Returns:SearchExpressionContext

a SearchExpressionContext instance

Since
2.3
createSearchExpressionContextback to summary
public static SearchExpressionContext createSearchExpressionContext(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
getExpressionHintsback to summary
public abstract Set<SearchExpressionHint> getExpressionHints()

Returns hints that influence the behavior of resolving the expression.

Returns:Set<SearchExpressionHint>

a non-empty, unmodifiable collection of SearchExpressionHints

Since
2.3
getFacesContextback to summary
public abstract FacesContext getFacesContext()

Returns the FacesContext for the current request.

Returns:FacesContext

the FacesContext.

Since
2.3
getSourceback to summary
public abstract UIComponent getSource()

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

Returns:UIComponent

the source component.

Since
2.3
getVisitHintsback to summary
public abstract Set<VisitHint> getVisitHints()

Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver implementation.

Returns:Set<VisitHint>

a non-empty, unmodifiable collection of VisitHints

Since
2.3
See Also
jakarta.faces.component.visit.VisitContext#getHints()