jakarta.faces.component.search.SearchKeywordContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation
EE4J Compatible Implementation for Jakarta Faces API
The newest version!
/*
 * Copyright (c) 1997, 2020 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 jakarta.faces.component.search;

import jakarta.faces.component.ContextCallback;
import jakarta.faces.component.UIComponent;

/**
 * 
 * SearchKeywordContext provides context information that may be useful to
 * {@link SearchKeywordResolver#resolve} implementations.
 * 
 *
 * @since 2.3
 */
public class SearchKeywordContext {

    private final SearchExpressionContext searchExpressionContext;
    private final ContextCallback callback;
    private final String remainingExpression;

    private boolean keywordResolved;

    /**
     * 
     * Construct a new context with the given arguments.
     * 
     *
     * @param searchExpressionContext the {@link SearchExpressionContext} for the current request.
     * @param callback the {@link ContextCallback}.
     * @param remainingExpression the remaining expression.
     */
    public SearchKeywordContext(SearchExpressionContext searchExpressionContext, ContextCallback callback, String remainingExpression) {
        this.searchExpressionContext = searchExpressionContext;
        this.callback = callback;
        this.remainingExpression = remainingExpression;
    }

    /**
     * 
     * This method will be called by an implementation of {@link SearchKeywordResolver#resolve} with the resolved component
     * for the keyword.
     * 
     *
     * @param target the resolved {@link UIComponent}.
     *
     * @since 2.3
     */
    public void invokeContextCallback(UIComponent target) {
        keywordResolved = true;
        callback.invokeContextCallback(searchExpressionContext.getFacesContext(), target);
    }

    /**
     * 
     * Returns the {@link SearchExpressionContext} for the current request.
     * 
     *
     * @return the {@link SearchExpressionContext}.
     *
     * @since 2.3
     */
    public SearchExpressionContext getSearchExpressionContext() {
        return searchExpressionContext;
    }

    /**
     * 
     * Returns the {@link ContextCallback} for the current request.
     * 
     *
     * @return the {@link ContextCallback}.
     *
     * @since 2.3
     */
    public ContextCallback getCallback() {
        return callback;
    }

    /**
     * 
     * Returns the remaining expression for the current request.
     * 
     *
     * @return the remaining expression.
     *
     * @since 2.3
     */
    public String getRemainingExpression() {
        return remainingExpression;
    }

    /**
     * 
     * Returns if the keyword was resolved.
     * 
     *
     * @return if the keyword was resolved.
     *
     * @since 2.3
     */
    public boolean isKeywordResolved() {
        return keywordResolved;
    }

    /**
     * 
     * Sets if the keyword was resolved.
     * 
     *
     * @param keywordResolved if the keyword was resolved.
     *
     * @since 2.3
     */
    public void setKeywordResolved(boolean keywordResolved) {
        this.keywordResolved = keywordResolved;
    }
}