Class SimpleEvaluationContext
- All Implemented Interfaces:
EvaluationContext
EvaluationContext
that focuses on a subset
of essential SpEL features and customization options, targeting simple
condition evaluation and in particular data binding scenarios.
In many cases, the full extent of the SpEL language is not required and
should be meaningfully restricted. Examples include but are not limited to
data binding expressions, property-based filters, and others. To that effect,
SimpleEvaluationContext
is tailored to support only a subset of the
SpEL language syntax, e.g. excluding references to Java types, constructors,
and bean references.
When creating a SimpleEvaluationContext
you need to choose the
level of support that you need for property access in SpEL expressions:
- A custom
PropertyAccessor
(typically not reflection-based), potentially combined with aDataBindingPropertyAccessor
- Data binding properties for read-only access
- Data binding properties for read and write
Conveniently, forReadOnlyDataBinding()
enables read access to properties via DataBindingPropertyAccessor
;
same for forReadWriteDataBinding()
when
write access is needed as well. Alternatively, configure custom accessors
via forPropertyAccessors(org.springframework.expression.PropertyAccessor...)
, and potentially
activate method resolution and/or a type converter through the builder.
Note that SimpleEvaluationContext
is typically not configured
with a default root object. Instead it is meant to be created once and
used repeatedly through getValue
calls on a pre-compiled
Expression
with both an
EvaluationContext
and a root object as arguments:
Expression.getValue(EvaluationContext, Object)
.
For more power and flexibility, in particular for internal configuration
scenarios, consider using StandardEvaluationContext
instead.
- Since:
- 4.3.15
- Author:
- Rossen Stoyanchev, Juergen Hoeller
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder forSimpleEvaluationContext
. -
Method Summary
Modifier and TypeMethodDescriptionforPropertyAccessors
(PropertyAccessor... accessors) Create aSimpleEvaluationContext
for the specifiedPropertyAccessor
delegates: typically a customPropertyAccessor
specific to a use case (e.g.Create aSimpleEvaluationContext
for read-only access to public properties viaDataBindingPropertyAccessor
.Create aSimpleEvaluationContext
for read-write access to public properties viaDataBindingPropertyAccessor
.SimpleEvaluationContext
does not support the use of bean references.Return an empty list, always, since this context does not support the use of type references.Return the specifiedMethodResolver
delegates, if any.Return an instance ofStandardOperatorOverloader
.Return the specifiedPropertyAccessor
delegates, if any.Return the specified root object, if any.Return an instance ofStandardTypeComparator
.The configuredTypeConverter
.SimpleEvaluationContext
does not support use of type references.lookupVariable
(String name) Look up a named variable within this evaluation context.void
setVariable
(String name, Object value) Set a named variable within this evaluation context to a specified value.
-
Method Details
-
getRootObject
Return the specified root object, if any.- Specified by:
getRootObject
in interfaceEvaluationContext
-
getPropertyAccessors
Return the specifiedPropertyAccessor
delegates, if any.- Specified by:
getPropertyAccessors
in interfaceEvaluationContext
- See Also:
-
getConstructorResolvers
Return an empty list, always, since this context does not support the use of type references.- Specified by:
getConstructorResolvers
in interfaceEvaluationContext
-
getMethodResolvers
Return the specifiedMethodResolver
delegates, if any.- Specified by:
getMethodResolvers
in interfaceEvaluationContext
- See Also:
-
getBeanResolver
SimpleEvaluationContext
does not support the use of bean references.- Specified by:
getBeanResolver
in interfaceEvaluationContext
- Returns:
- always
null
-
getTypeLocator
SimpleEvaluationContext
does not support use of type references.- Specified by:
getTypeLocator
in interfaceEvaluationContext
- Returns:
TypeLocator
implementation that raises aSpelEvaluationException
withSpelMessage.TYPE_NOT_FOUND
.
-
getTypeConverter
The configuredTypeConverter
.By default this is
StandardTypeConverter
. -
getTypeComparator
Return an instance ofStandardTypeComparator
.- Specified by:
getTypeComparator
in interfaceEvaluationContext
-
getOperatorOverloader
Return an instance ofStandardOperatorOverloader
.- Specified by:
getOperatorOverloader
in interfaceEvaluationContext
-
setVariable
Description copied from interface:EvaluationContext
Set a named variable within this evaluation context to a specified value.- Specified by:
setVariable
in interfaceEvaluationContext
- Parameters:
name
- the name of the variable to setvalue
- the value to be placed in the variable
-
lookupVariable
Description copied from interface:EvaluationContext
Look up a named variable within this evaluation context.- Specified by:
lookupVariable
in interfaceEvaluationContext
- Parameters:
name
- variable to lookup- Returns:
- the value of the variable, or
null
if not found
-
forPropertyAccessors
Create aSimpleEvaluationContext
for the specifiedPropertyAccessor
delegates: typically a customPropertyAccessor
specific to a use case (e.g. attribute resolution in a custom data structure), potentially combined with aDataBindingPropertyAccessor
if property dereferences are needed as well.- Parameters:
accessors
- the accessor delegates to use- See Also:
-
forReadOnlyDataBinding
Create aSimpleEvaluationContext
for read-only access to public properties viaDataBindingPropertyAccessor
. -
forReadWriteDataBinding
Create aSimpleEvaluationContext
for read-write access to public properties viaDataBindingPropertyAccessor
.
-