SearchExpressionContext

java.lang.Object
- jakarta.faces.component.search.SearchExpressionContext

```
public abstract class SearchExpressionContext
extends java.lang.Object
```
A context object that is used to hold state relating to resolve a search expression.

Since:

2.3

See Also:

SearchExpressionHandler

Constructor Summary

Constructors
Constructor and Description

SearchExpressionContext()

Constructors
Constructor and Description
`SearchExpressionContext()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchExpressionContext`	`createSearchExpressionContext(FacesContext context, UIComponent source)` Creates a `SearchExpressionContext` instance for use with the `SearchExpressionHandler`.
`static SearchExpressionContext`	`createSearchExpressionContext(FacesContext context, UIComponent source, java.util.Set<SearchExpressionHint> expressionHints, java.util.Set<VisitHint> visitHints)` Creates a `SearchExpressionContext` instance for use with the `SearchExpressionHandler`.
`abstract java.util.Set<SearchExpressionHint>`	`getExpressionHints()` Returns hints that influence the behavior of resolving the expression.
`abstract FacesContext`	`getFacesContext()` Returns the FacesContext for the current request.
`abstract UIComponent`	`getSource()` Returns the source / base component from which we will start to perform our search.
`abstract java.util.Set<VisitHint>`	`getVisitHints()` Returns hints that influence the behavior of the tree visit, if it's used by an `SearchKeywordResolver` implementation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SearchExpressionContext
```
public SearchExpressionContext()
```
- Method Detail
  - getSource
```
public abstract UIComponent getSource()
```
    Returns the source / base component from which we will start to perform our search.
    
    Returns:
    
    the source component.
    
    Since:
    
    2.3
  - getVisitHints
```
public abstract java.util.Set<VisitHint> getVisitHints()
```
    Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver implementation.
    
    Returns:
    
    a non-empty, unmodifiable collection of VisitHints
    
    Since:
    
    2.3
    
    See Also:
    
    VisitContext.getHints()
  - getExpressionHints
```
public abstract java.util.Set<SearchExpressionHint> getExpressionHints()
```
    Returns hints that influence the behavior of resolving the expression.
    
    Returns:
    
    a non-empty, unmodifiable collection of SearchExpressionHints
    
    Since:
    
    2.3
  - getFacesContext
```
public abstract FacesContext getFacesContext()
```
    Returns the FacesContext for the current request.
    
    Returns:
    
    the FacesContext.
    
    Since:
    
    2.3
  - createSearchExpressionContext
```
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 - the FacesContext for the current request
    
    source - the source / base component from which we will start to perform our search.
    
    Returns:
    
    a SearchExpressionContext instance
    
    Since:
    
    2.3
  - createSearchExpressionContext
```
public static SearchExpressionContext createSearchExpressionContext(FacesContext context,
                                                                    UIComponent source,
                                                                    java.util.Set<SearchExpressionHint> expressionHints,
                                                                    java.util.Set<VisitHint> visitHints)
```
    Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
    
    Parameters:
    
    context - the FacesContext for the current request
    
    source - the source / base component from which we will start to perform our search.
    
    expressionHints - the SearchExpressionHint to apply to the search. If null, no hints are applied.
    
    visitHints - the VisitHints to apply to the visit, if used by a SearchKeywordResolver. If null, no hints are applied.
    
    Returns:
    
    a SearchExpressionContext instance
    
    Since:
    
    2.3

Class SearchExpressionContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchExpressionContext

Method Detail

getSource

getVisitHints

getExpressionHints

getFacesContext

createSearchExpressionContext

createSearchExpressionContext