javax.faces.el.ValueBinding Maven / Gradle / Ivy
/*
* $Id: ValueBinding.java,v 1.14 2005/12/05 16:42:53 edburns Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.el;
import javax.faces.context.FacesContext;
/**
* ValueBinding is an object that can be used
* to access the property represented by an action or value binding
* expression. An immutable {@link ValueBinding} for a particular value binding
* can be acquired by calling the createValueBinding() method of
* the {@link javax.faces.application.Application} instance for this web
* application.
*
* @deprecated This has been replaced by {@link javax.el.ValueExpression}.
*/
public abstract class ValueBinding {
/**
* Return the value of the property represented by this
* {@link ValueBinding}, relative to the specified {@link FacesContext}.
*
*
* @param context {@link FacesContext} for the current request
*
* @throws EvaluationException if an exception is thrown while getting
* the value (the thrown exception must be included as the
* cause property of this exception)
* @throws NullPointerException if context
* is null
* @throws PropertyNotFoundException if a specified property name
* does not exist, or is not readable
*/
public abstract Object getValue(FacesContext context)
throws EvaluationException, PropertyNotFoundException;
/**
* Set the value of the property represented by this
* {@link ValueBinding}, relative to the specified {@link FacesContext}.
*
*
* @param context {@link FacesContext} for the current request
* @param value The new value to be set
*
* @throws EvaluationException if an exception is thrown while setting
* the value (the thrown exception must be included as the
* cause property of this exception)
* @throws NullPointerException if context
* is null
* @throws PropertyNotFoundException if a specified property name
* does not exist, or is not writeable
*/
public abstract void setValue(FacesContext context, Object value)
throws EvaluationException, PropertyNotFoundException;
/**
* Return true if the specified property of the specified
* property is known to be immutable; otherwise, return
* false.
*
* @param context {@link FacesContext} for the current request
*
* @throws EvaluationException if an exception is thrown while getting
* the description of the property (the thrown exception must be
* included as the cause property of this exception)
* @throws NullPointerException if context
* is null
* @throws PropertyNotFoundException if a specified property name
* does not exist
*/
public abstract boolean isReadOnly(FacesContext context)
throws EvaluationException, PropertyNotFoundException;
/**
* Return the type of the property represented by this
* {@link ValueBinding}, relative to the specified {@link FacesContext}.
*
*
* @param context {@link FacesContext} for the current request
*
* @throws EvaluationException if an exception is thrown while getting
* the description of the property (the thrown exception must be
* included as the cause property of this exception)
* @throws NullPointerException if context
* is null
* @throws PropertyNotFoundException if a specified property name
* does not exist
*/
public abstract Class getType(FacesContext context)
throws EvaluationException, PropertyNotFoundException;
/**
* Return the (possibly null) expression String,
* including the delimiters, from which this
* ValueBinding was built.
*
*/
public String getExpressionString() {
return null;
}
}