Class ValueExpressionImpl
- All Implemented Interfaces:
Externalizable, Serializable
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 ExpressionFactory.createValueExpression(ELContext, String, Class) method can be used to parse an expression string and
return a concrete instance of ValueExpression that encapsulates the parsed expression. The
FunctionMapper is used at parse time, not evaluation time, so one is not needed to evaluate an expression
using this class. However, the ELContext is needed at evaluation time.
The getValue(ELContext), setValue(ELContext, Object), isReadOnly(ELContext) and getType(ELContext) methods will evaluate the
expression each time they are called. The 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 ELResolver.getValue(ELContext, Object, Object) 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 ELResolver.getValue(ELContext, Object, Object),
ELResolver.setValue(ELContext, Object, Object, Object), ELResolver.isReadOnly(ELContext, Object, Object) or
ELResolver.getType(ELContext, Object, Object) method, depending on which was called on the ValueExpression.
See the notes about comparison, serialization and immutability in the Expression javadocs.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new ValueExpressionImpl.ValueExpressionImpl(String expr, org.apache.el.parser.Node node, FunctionMapper fnMapper, VariableMapper varMapper, Class<?> expectedType) Constructs a new ValueExpressionImpl. -
Method Summary
Modifier and TypeMethodDescriptionbooleanClass<?> Returns the expected type of the result of this expression.Returns the type the result of the expression will be coerced to after evaluation.Class<?> Returns the type of the result produced by evaluating this expression.<T> TEvaluates this expression and returns the result.getValueReference(ELContext context) Returns a reference to the resolved property for this expression.inthashCode()booleanReturns whether this expression is a literal text expression, meaning it does not contain any variables, functions, or operators and evaluates to a constant value.booleanisReadOnly(ELContext context) Determines whether the property referenced by this expression is read-only.voidvoidSets the value of the property referenced by this expression.toString()void
-
Constructor Details
-
ValueExpressionImpl
public ValueExpressionImpl()Constructs a new ValueExpressionImpl. -
ValueExpressionImpl
public ValueExpressionImpl(String expr, org.apache.el.parser.Node node, FunctionMapper fnMapper, VariableMapper varMapper, Class<?> expectedType) Constructs a new ValueExpressionImpl.- Parameters:
expr- The expression stringnode- The AST nodefnMapper- The function mappervarMapper- The variable mapperexpectedType- The expected return type
-
-
Method Details
-
equals
- Specified by:
equalsin classExpression
-
getExpectedType
Description copied from class:jakarta.el.ValueExpressionReturns the expected type of the result of this expression.- Specified by:
getExpectedTypein classValueExpression- Returns:
- The expected result type, or
Object.classif no specific type is expected
-
getExpressionString
Returns the type the result of the expression will be coerced to after evaluation.- Specified by:
getExpressionStringin classExpression- Returns:
- the
expectedTypepassed to theExpressionFactory.createValueExpressionmethod that created thisValueExpression. - See Also:
-
getType
Description copied from class:jakarta.el.ValueExpressionReturns the type of the result produced by evaluating this expression.- Specified by:
getTypein classValueExpression- Parameters:
context- The EL context for this evaluation- Returns:
- The type of the result of this value expression
- Throws:
PropertyNotFoundException- If a property/variable resolution failed because no match was found or a match was found but was not readableELException- Wraps any exception throw whilst resolving a property or variable
-
getValue
Description copied from class:jakarta.el.ValueExpressionEvaluates this expression and returns the result.- Specified by:
getValuein classValueExpression- Type Parameters:
T- The expected type for the result of evaluating this value expression- Parameters:
context- The EL context for this evaluation- Returns:
- The result of evaluating this value expression
- Throws:
PropertyNotFoundException- If a property/variable resolution failed because no match was found or a match was found but was not readableELException- Wraps any exception throw whilst resolving a property or variable
-
hashCode
public int hashCode()- Specified by:
hashCodein classExpression
-
isLiteralText
public boolean isLiteralText()Description copied from class:jakarta.el.ExpressionReturns whether this expression is a literal text expression, meaning it does not contain any variables, functions, or operators and evaluates to a constant value.- Specified by:
isLiteralTextin classExpression- Returns:
trueif this expression is a literal text,falseotherwise
-
isReadOnly
Description copied from class:jakarta.el.ValueExpressionDetermines whether the property referenced by this expression is read-only.- Specified by:
isReadOnlyin classValueExpression- Parameters:
context- The EL context for this evaluation- Returns:
trueif this expression is read only otherwisefalse- Throws:
PropertyNotFoundException- If a property/variable resolution failed because no match was found or a match was found but was not readableELException- Wraps any exception throw whilst resolving a property or variable
-
readExternal
- Specified by:
readExternalin interfaceExternalizable- Throws:
IOExceptionClassNotFoundException
-
setValue
public void setValue(ELContext context, Object value) throws PropertyNotFoundException, PropertyNotWritableException, ELException Description copied from class:jakarta.el.ValueExpressionSets the value of the property referenced by this expression.- Specified by:
setValuein classValueExpression- Parameters:
context- The EL context for this evaluationvalue- The value to set the property to which this value expression refers- Throws:
PropertyNotFoundException- If a property/variable resolution failed because no match was foundPropertyNotWritableException- If a property/variable resolution failed because a match was found but was not writableELException- Wraps any exception throw whilst resolving a property or variable
-
writeExternal
- Specified by:
writeExternalin interfaceExternalizable- Throws:
IOException
-
toString
-
getValueReference
Description copied from class:jakarta.el.ValueExpressionReturns a reference to the resolved property for this expression.This default implementation always returns
null. Subclasses should override this method to provide the resolved base object and property.- Overrides:
getValueReferencein classValueExpression- Parameters:
context- The EL context for this evaluation- Returns:
- This default implementation always returns
null
-