jakarta.faces.el.VariableResolver Maven / Gradle / Ivy

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

There is a newer version: 4.1.1

/*
 * 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.el;

import jakarta.faces.context.FacesContext;

/**
 * 
 * VariableResolver represents a pluggable mechanism for resolving a top-level variable reference at
 * evaluation time.
 * 
 *
 * @deprecated This has been replaced by {@link jakarta.el.ELResolver} when operating with a null
 * base argument.
 */

@Deprecated
public abstract class VariableResolver {

    /**
     * 
     * Resolve the specified variable name, and return the corresponding object, if any; otherwise, return
     * null.
     * 
     *
     * @param context {@link FacesContext} against which to resolve this variable name
     * @param name Name of the variable to be resolved
     *
     * @throws EvaluationException if an exception is thrown while resolving the variable name (the thrown exception must be
     * included as the cause property of this exception)
     * @throws NullPointerException if context or name is null
     *
     * @return the result of the resolution
     */
    public abstract Object resolveVariable(FacesContext context, String name) throws EvaluationException;

}