FileDocCategorySizeDatePackage
ValueExpression.javaAPI DocGlassfish v2 API7810Fri Feb 17 14:04:54 GMT 2006javax.el

ValueExpression

public abstract class ValueExpression extends Expression
An Expression that can get or set a value.

In previous incarnations of this API, expressions could only be read. ValueExpression objects can now be used both to retrieve a value and to set a value. Expressions that can have a value set on them are referred to as l-value expressions. Those that cannot are referred to as r-value expressions. Not all r-value expressions can be used as l-value expressions (e.g. "${1+1}" or "${firstName} ${lastName}"). See the EL Specification for details. Expressions that cannot be used as l-values must always return true from isReadOnly().

The {@link ExpressionFactory#createValueExpression} method can be used to parse an expression string and return a concrete instance of ValueExpression that encapsulates the parsed expression. The {@link FunctionMapper} is used at parse time, not evaluation time, so one is not needed to evaluate an expression using this class. However, the {@link ELContext} is needed at evaluation time.

The {@link #getValue}, {@link #setValue}, {@link #isReadOnly} and {@link #getType} methods will evaluate the expression each time they are called. The {@link ELResolver} in the ELContext is used to resolve the top-level variables and to determine the behavior of the . and [] operators. For any of the four methods, the {@link ELResolver#getValue} method is used to resolve all properties up to but excluding the last one. This provides the base object. At the last resolution, the ValueExpression will call the corresponding {@link ELResolver#getValue}, {@link ELResolver#setValue}, {@link ELResolver#isReadOnly} or {@link ELResolver#getType} method, depending on which was called on the ValueExpression.

See the notes about comparison, serialization and immutability in the {@link Expression} javadocs.

see
ELResolver
see
Expression
see
ExpressionFactory
since
JSP 2.1

Fields Summary
Constructors Summary
Methods Summary
public abstract java.lang.ClassgetExpectedType()
Returns the type the result of the expression will be coerced to after evaluation.

return
the expectedType passed to the ExpressionFactory.createValueExpression method that created this ValueExpression.

public abstract java.lang.ClassgetType(javax.el.ELContext context)
Evaluates the expression relative to the provided context, and returns the most general type that is acceptable for an object to be passed as the value parameter in a future call to the {@link #setValue} method.

This is not always the same as getValue().getClass(). For example, in the case of an expression that references an array element, the getType method will return the element type of the array, which might be a superclass of the type of the actual element that is currently in the specified array element.

param
context The context of this evaluation.
return
the most general acceptable type; otherwise undefined.
throws
NullPointerException if context is null.
throws
PropertyNotFoundException if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
throws
ELException if an exception was thrown while performing property or variable resolution. The thrown exception must be included as the cause property of this exception, if available.

public abstract java.lang.ObjectgetValue(javax.el.ELContext context)
Evaluates the expression relative to the provided context, and returns the resulting value.

The resulting value is automatically coerced to the type returned by getExpectedType(), which was provided to the ExpressionFactory when this expression was created.

param
context The context of this evaluation.
return
The result of the expression evaluation.
throws
NullPointerException if context is null.
throws
PropertyNotFoundException if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
throws
ELException if an exception was thrown while performing property or variable resolution. The thrown exception must be included as the cause property of this exception, if available.

public abstract booleanisReadOnly(javax.el.ELContext context)
Evaluates the expression relative to the provided context, and returns true if a call to {@link #setValue} will always fail.

param
context The context of this evaluation.
return
true if the expression is read-only or false if not.
throws
NullPointerException if context is null.
throws
PropertyNotFoundException if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
throws
ELException if an exception was thrown while performing property or variable resolution. The thrown exception must be included as the cause property of this exception, if available. *
throws
NullPointerException if context is null

public abstract voidsetValue(javax.el.ELContext context, java.lang.Object value)
Evaluates the expression relative to the provided context, and sets the result to the provided value.

param
context The context of this evaluation.
param
value The new value to be set.
throws
NullPointerException if context is null.
throws
PropertyNotFoundException if one of the property resolutions failed because a specified variable or property does not exist or is not readable.
throws
PropertyNotWritableException if the final variable or property resolution failed because the specified variable or property is not writable.
throws
ELException if an exception was thrown while attempting to set the property or variable. The thrown exception must be included as the cause property of this exception, if available.