javax.faces.component.search.SearchExpressionContext Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.faces.component.search;
import java.util.Set;
import javax.faces.FactoryFinder;
import javax.faces.component.UIComponent;
import javax.faces.component.visit.VisitHint;
import javax.faces.context.FacesContext;
/**
* A context object that is used to hold
* state relating to resolve a search expression.
*
* @see SearchExpressionHandler
*
* @since 2.3
*/
public abstract class SearchExpressionContext {
/**
* Returns the source / base component from which we will start to perform our search.
*
* @return the source component.
*
* @since 2.3
*/
public abstract UIComponent getSource();
/**
* Returns hints that influence the behavior of the tree visit,
* if it's used by an {@link SearchKeywordResolver} implementation.
*
* @return a non-empty, unmodifiable collection of {@link VisitHint}s
*
* @since 2.3
* @see javax.faces.component.visit.VisitContext#getHints()
*/
public abstract Set getVisitHints();
/**
* Returns hints that influence the behavior of resolving the expression.
*
* @return a non-empty, unmodifiable collection of {@link SearchExpressionHint}s
*
* @since 2.3
*/
public abstract Set getExpressionHints();
/**
* Returns the FacesContext for the
* current request.
*
* @return the FacesContext.
*
* @since 2.3
*/
public abstract FacesContext getFacesContext();
/**
* Creates a {@link SearchExpressionContext} instance
* for use with the {@link SearchExpressionHandler}.
* This method can be used to obtain a SearchExpressionContext instance
* without any {@link VisitHint} or {@link SearchExpressionHint}.
*
* @param context the FacesContext for the current request
* @param source the source / base component from which we will start to perform our search.
*
* @return a {@link SearchExpressionContext} instance
*
* @since 2.3
*/
public static SearchExpressionContext createSearchExpressionContext(FacesContext context, UIComponent source) {
return createSearchExpressionContext(context, source, null, null);
}
/**
* Creates a {@link SearchExpressionContext} instance
* for use with the {@link SearchExpressionHandler}.
*
* @param context the FacesContext for the current request
* @param source the source / base component from which we will start to perform our search.
* @param expressionHints the SearchExpressionHint to apply to the search.
* If null, no hints are applied.
* @param visitHints the VisitHints to apply to the visit, if used by a {@link SearchKeywordResolver}.
* If null, no hints are applied.
*
* @return a {@link SearchExpressionContext} instance
*
* @since 2.3
*/
public static SearchExpressionContext createSearchExpressionContext(FacesContext context, UIComponent source,
Set expressionHints, Set visitHints) {
SearchExpressionContextFactory factory
= (SearchExpressionContextFactory) FactoryFinder.getFactory(FactoryFinder.SEARCH_EXPRESSION_CONTEXT_FACTORY);
return factory.getSearchExpressionContext(context, source, expressionHints, visitHints);
}
}