Top Description Inners Fields Constructors Methods
org.springframework.context.expression

public abstract Class CachedExpressionEvaluator

extends Object
Class Inheritance
Known Direct Subclasses
org.springframework.cache.interceptor.CacheOperationExpressionEvaluator, org.springframework.context.event.EventExpressionEvaluator
Imports
java.util.Map, org.springframework.core.DefaultParameterNameDiscoverer, .ParameterNameDiscoverer, org.springframework.expression.Expression, org.springframework.expression.spel.standard.SpelExpressionParser, org.springframework.lang.Nullable, org.springframework.util.Assert, .ObjectUtils

Shared utility class used to evaluate and cache SpEL expressions that are defined on java.lang.reflect.AnnotatedElement.
Author
Stephane Nicoll
Since
4.2
See Also
AnnotatedElementKey

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static class

Field Summary

Modifier and TypeField and Description
private final ParameterNameDiscoverer
private final SpelExpressionParser

Constructor Summary

AccessConstructor and Description
protected
CachedExpressionEvaluator(SpelExpressionParser parser)

Create a new instance with the specified SpelExpressionParser.

protected
CachedExpressionEvaluator()

Create a new instance with a default SpelExpressionParser.

Method Summary

Modifier and TypeMethod and Description
private CachedExpressionEvaluator.ExpressionKey
createKey(AnnotatedElementKey elementKey, String expression)

protected Expression
getExpression(Map<CachedExpressionEvaluator.ExpressionKey, Expression>
the cache to use
cache
,
AnnotatedElementKey
the element on which the expression is defined
elementKey
,
String
the expression to parse
expression
)

Return the Expression for the specified SpEL value

Parse the expression if it hasn't been already.

protected ParameterNameDiscoverer
getParameterNameDiscoverer()

Return a shared parameter name discoverer which caches data internally.

protected SpelExpressionParser
getParser()

Return the SpelExpressionParser to use.

protected Expression
parseExpression(String
the expression to parse
expression
)

Parse the specified expression.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

parameterNameDiscovererback to summary
private final ParameterNameDiscoverer parameterNameDiscoverer
parserback to summary
private final SpelExpressionParser parser

Constructor Detail

CachedExpressionEvaluatorback to summary
protected CachedExpressionEvaluator(SpelExpressionParser parser)

Create a new instance with the specified SpelExpressionParser.

CachedExpressionEvaluatorback to summary
protected CachedExpressionEvaluator()

Create a new instance with a default SpelExpressionParser.

Method Detail

createKeyback to summary
private CachedExpressionEvaluator.ExpressionKey createKey(AnnotatedElementKey elementKey, String expression)
getExpressionback to summary
protected Expression getExpression(Map<CachedExpressionEvaluator.ExpressionKey, Expression> cache, AnnotatedElementKey elementKey, String expression)

Return the Expression for the specified SpEL value

Parse the expression if it hasn't been already.

Parameters
cache:Map<CachedExpressionEvaluator.ExpressionKey, Expression>

the cache to use

elementKey:AnnotatedElementKey

the element on which the expression is defined

expression:String

the expression to parse

getParameterNameDiscovererback to summary
protected ParameterNameDiscoverer getParameterNameDiscoverer()

Return a shared parameter name discoverer which caches data internally.

Since
4.3
getParserback to summary
protected SpelExpressionParser getParser()

Return the SpelExpressionParser to use.

parseExpressionback to summary
protected Expression parseExpression(String expression)

Parse the specified expression.

Parameters
expression:String

the expression to parse

Since
5.3.13
org.springframework.context.expression back to summary

protected Class CachedExpressionEvaluator.ExpressionKey

extends Object
implements Comparable<CachedExpressionEvaluator.ExpressionKey>
Class Inheritance
  • java.lang.Object
  • org.springframework.context.expression.CachedExpressionEvaluator.ExpressionKey
All Implemented Interfaces
java.lang.Comparable

An expression key.

Field Summary

Modifier and TypeField and Description
private final AnnotatedElementKey
private final String

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(CachedExpressionEvaluator.ExpressionKey
the object to be compared.
other
)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public boolean
equals(Object
the reference object with which to compare.
other
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

elementback to summary
private final AnnotatedElementKey element
expressionback to summary
private final String expression

Constructor Detail

ExpressionKeyback to summary
protected ExpressionKey(AnnotatedElementKey element, String expression)

Method Detail

compareToback to summary
public int compareTo(CachedExpressionEvaluator.ExpressionKey other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:CachedExpressionEvaluator.ExpressionKey

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override