public class SpelExpression extends Object implements Expression
SpelExpression
represents a parsed (valid) expression that is ready to be
evaluated in a specified context. An expression can be evaluated standalone or in a
specified context. During expression evaluation the context may be asked to resolve
references to types, beans, properties, and methods.Constructor and Description |
---|
SpelExpression(String expression,
SpelNodeImpl ast,
SpelParserConfiguration configuration)
Construct an expression, only used by the parser.
|
Modifier and Type | Method and Description |
---|---|
boolean |
compileExpression()
Perform expression compilation.
|
SpelNode |
getAST() |
EvaluationContext |
getEvaluationContext()
Return the default evaluation context that will be used if none is supplied on an evaluation call.
|
String |
getExpressionString()
Returns the original string used to create this expression, unmodified.
|
Object |
getValue()
Evaluate this expression in the default standard context.
|
<T> T |
getValue(Class<T> expectedResultType)
Evaluate the expression in the default context.
|
Object |
getValue(EvaluationContext context)
Evaluate this expression in the provided context and return the result of evaluation.
|
<T> T |
getValue(EvaluationContext context,
Class<T> expectedResultType)
Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc -
the type of the evaluation result is expected to be of a particular class and an exception will be thrown if it
is not and cannot be converted to that type.
|
Object |
getValue(EvaluationContext context,
Object rootObject)
Evaluate this expression in the provided context and return the result of evaluation, but use
the supplied root context as an override for any default root object specified in the context.
|
<T> T |
getValue(EvaluationContext context,
Object rootObject,
Class<T> expectedResultType)
Evaluate the expression in a specified context which can resolve references to properties, methods, types, etc -
the type of the evaluation result is expected to be of a particular class and an exception will be thrown if it
is not and cannot be converted to that type.
|
Object |
getValue(Object rootObject)
Evaluate this expression against the specified root object
|
<T> T |
getValue(Object rootObject,
Class<T> expectedResultType)
Evaluate the expression in the default context against the specified root object.
|
Class<?> |
getValueType()
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method using the default context. |
Class<?> |
getValueType(EvaluationContext context)
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method for the given context. |
Class<?> |
getValueType(EvaluationContext context,
Object rootObject)
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method for the given context. |
Class<?> |
getValueType(Object rootObject)
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method using the default context. |
TypeDescriptor |
getValueTypeDescriptor()
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method using the default context. |
TypeDescriptor |
getValueTypeDescriptor(EvaluationContext context)
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method for the given context. |
TypeDescriptor |
getValueTypeDescriptor(EvaluationContext context,
Object rootObject)
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object) method for
the given context. |
TypeDescriptor |
getValueTypeDescriptor(Object rootObject)
Returns the most general type that can be passed to the
Expression.setValue(EvaluationContext, Object)
method using the default context. |
boolean |
isWritable(EvaluationContext context)
Determine if an expression can be written to, i.e.
|
boolean |
isWritable(EvaluationContext context,
Object rootObject)
Determine if an expression can be written to, i.e.
|
boolean |
isWritable(Object rootObject)
Determine if an expression can be written to, i.e.
|
void |
revertToInterpreted()
Cause an expression to revert to being interpreted if it has been using a compiled
form.
|
void |
setEvaluationContext(EvaluationContext evaluationContext)
Set the evaluation context that will be used if none is specified on an evaluation call.
|
void |
setValue(EvaluationContext context,
Object value)
Set this expression in the provided context to the value provided.
|
void |
setValue(EvaluationContext context,
Object rootObject,
Object value)
Set this expression in the provided context to the value provided.
|
void |
setValue(Object rootObject,
Object value)
Set this expression in the provided context to the value provided.
|
String |
toStringAST()
Produce a string representation of the Abstract Syntax Tree for the expression, this should ideally look like the
input expression, but properly formatted since any unnecessary whitespace will have been discarded during the
parse of the expression.
|
public SpelExpression(String expression, SpelNodeImpl ast, SpelParserConfiguration configuration)
public void setEvaluationContext(EvaluationContext evaluationContext)
evaluationContext
- the evaluation context to usepublic EvaluationContext getEvaluationContext()
public Object getValue() throws EvaluationException
Expression
getValue
in interface Expression
EvaluationException
- if there is a problem during evaluationpublic Object getValue(Object rootObject) throws EvaluationException
Expression
getValue
in interface Expression
rootObject
- the root object against which properties/etc will be resolvedEvaluationException
- if there is a problem during evaluationpublic <T> T getValue(Class<T> expectedResultType) throws EvaluationException
Expression
getValue
in interface Expression
expectedResultType
- the class the caller would like the result to beEvaluationException
- if there is a problem during evaluationpublic <T> T getValue(Object rootObject, Class<T> expectedResultType) throws EvaluationException
Expression
getValue
in interface Expression
rootObject
- the root object against which properties/etc will be resolvedexpectedResultType
- the class the caller would like the result to beEvaluationException
- if there is a problem during evaluationpublic Object getValue(EvaluationContext context) throws EvaluationException
Expression
getValue
in interface Expression
context
- the context in which to evaluate the expressionEvaluationException
- if there is a problem during evaluationpublic Object getValue(EvaluationContext context, Object rootObject) throws EvaluationException
Expression
getValue
in interface Expression
context
- the context in which to evaluate the expressionrootObject
- the root object against which properties/etc will be resolvedEvaluationException
- if there is a problem during evaluationpublic <T> T getValue(EvaluationContext context, Class<T> expectedResultType) throws EvaluationException
Expression
getValue
in interface Expression
context
- the context in which to evaluate the expressionexpectedResultType
- the class the caller would like the result to beEvaluationException
- if there is a problem during evaluationpublic <T> T getValue(EvaluationContext context, Object rootObject, Class<T> expectedResultType) throws EvaluationException
Expression
getValue
in interface Expression
context
- the context in which to evaluate the expressionrootObject
- the root object against which properties/etc will be resolvedexpectedResultType
- the class the caller would like the result to beEvaluationException
- if there is a problem during evaluationpublic Class<?> getValueType() throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method using the default context.getValueType
in interface Expression
EvaluationException
- if there is a problem determining the typepublic Class<?> getValueType(Object rootObject) throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method using the default context.getValueType
in interface Expression
rootObject
- the root object against which to evaluate the expressionEvaluationException
- if there is a problem determining the typepublic Class<?> getValueType(EvaluationContext context) throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method for the given context.getValueType
in interface Expression
context
- the context in which to evaluate the expressionEvaluationException
- if there is a problem determining the typepublic Class<?> getValueType(EvaluationContext context, Object rootObject) throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method for the given context. The supplied root object overrides any specified in the context.getValueType
in interface Expression
context
- the context in which to evaluate the expressionrootObject
- the root object against which to evaluate the expressionEvaluationException
- if there is a problem determining the typepublic TypeDescriptor getValueTypeDescriptor() throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method using the default context.getValueTypeDescriptor
in interface Expression
EvaluationException
- if there is a problem determining the typepublic TypeDescriptor getValueTypeDescriptor(Object rootObject) throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method using the default context.getValueTypeDescriptor
in interface Expression
rootObject
- the root object against which to evaluate the expressionEvaluationException
- if there is a problem determining the typepublic TypeDescriptor getValueTypeDescriptor(EvaluationContext context) throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method for the given context.getValueTypeDescriptor
in interface Expression
context
- the context in which to evaluate the expressionEvaluationException
- if there is a problem determining the typepublic TypeDescriptor getValueTypeDescriptor(EvaluationContext context, Object rootObject) throws EvaluationException
Expression
Expression.setValue(EvaluationContext, Object)
method for
the given context. The supplied root object overrides any specified in the context.getValueTypeDescriptor
in interface Expression
context
- the context in which to evaluate the expressionrootObject
- the root object against which to evaluate the expressionEvaluationException
- if there is a problem determining the typepublic String getExpressionString()
Expression
getExpressionString
in interface Expression
public boolean isWritable(EvaluationContext context) throws EvaluationException
Expression
isWritable
in interface Expression
context
- the context in which the expression should be checkedEvaluationException
- if there is a problem determining if it is writablepublic boolean isWritable(Object rootObject) throws EvaluationException
Expression
isWritable
in interface Expression
rootObject
- the root object against which to evaluate the expressionEvaluationException
- if there is a problem determining if it is writablepublic boolean isWritable(EvaluationContext context, Object rootObject) throws EvaluationException
Expression
isWritable
in interface Expression
context
- the context in which the expression should be checkedrootObject
- the root object against which to evaluate the expressionEvaluationException
- if there is a problem determining if it is writablepublic void setValue(EvaluationContext context, Object value) throws EvaluationException
Expression
setValue
in interface Expression
context
- the context in which to set the value of the expressionvalue
- the new valueEvaluationException
- if there is a problem during evaluationpublic void setValue(Object rootObject, Object value) throws EvaluationException
Expression
setValue
in interface Expression
rootObject
- the root object against which to evaluate the expressionvalue
- the new valueEvaluationException
- if there is a problem during evaluationpublic void setValue(EvaluationContext context, Object rootObject, Object value) throws EvaluationException
Expression
setValue
in interface Expression
context
- the context in which to set the value of the expressionrootObject
- the root object against which to evaluate the expressionvalue
- the new valueEvaluationException
- if there is a problem during evaluationpublic boolean compileExpression()
public void revertToInterpreted()
public SpelNode getAST()
public String toStringAST()