Spring Framework 6.1.4 · org.springframework.cache.interceptor.NameMatchCacheOperationSource

Modifier and Type	Field and Description
protected static final Log	logger Logger available to subclasses.
private final Map<String, Collection<CacheOperation>>	nameMap Keys are method names; values are TransactionAttributes.

Access	Constructor and Description
public	NameMatchCacheOperationSource()

Method Summary

Modifier and Type	Method and Description
public void	addCacheMethod(String the name of the method methodName, Collection<CacheOperation> operation associated with the method ops) Add an attribute for a cacheable method.
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 Collection<CacheOperation>	getCacheOperations(Method the method to introspect method, Class<?> the target class (may be `null`, in which case the declaring class of the method must be used) targetClass) Implements org.springframework.cache.interceptor.CacheOperationSource.getCacheOperations. Return the collection of cache operations for this method, or `null` if the method contains no cacheable annotations.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
protected boolean	Returns: if the names match isMatch(String the method name of the class methodName, String the name in the descriptor mappedName) Return if the given method name matches the mapped name.
public void	setNameMap(Map<String, Collection<CacheOperation>> nameMap) Set a name/attribute map, consisting of method names (e.g. "myMethod") and CacheOperation instances (or Strings to be converted to CacheOperation instances).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

logger	back to summary
protected static final Log logger Logger available to subclasses. Static for optimal serialization.

nameMap	back to summary
private final Map<String, Collection<CacheOperation>> nameMap Keys are method names; values are TransactionAttributes.

NameMatchCacheOperationSource	back to summary
public NameMatchCacheOperationSource()

Method Detail

addCacheMethod	back to summary
public void addCacheMethod(String methodName, Collection<CacheOperation> ops) Add an attribute for a cacheable method. Method names can be exact matches, or of the pattern "xxx", "xxx" or "xxx" for matching multiple methods. Parameters methodName:String the name of the method ops:Collection<CacheOperation> operation associated with the method

addCacheMethod

back to summary

public void addCacheMethod(String methodName, Collection<CacheOperation> ops)

Add an attribute for a cacheable method.

Method names can be exact matches, or of the pattern "xxx*", "*xxx" or "*xxx*" for matching multiple methods.

Parameters

methodName:String: the name of the method
ops:Collection<CacheOperation>: operation associated with the method

equals back to summary

equals	back 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

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

getCacheOperations back to summary

getCacheOperations	back to summary
public Collection<CacheOperation> getCacheOperations(Method method, Class<?> targetClass) Implements org.springframework.cache.interceptor.CacheOperationSource.getCacheOperations. Doc from org.springframework.cache.interceptor.CacheOperationSource.getCacheOperations. Return the collection of cache operations for this method, or `null` if the method contains no cacheable annotations. Parameters method:Method the method to introspect targetClass:Class<?> the target class (may be `null`, in which case the declaring class of the method must be used) Returns:Collection<CacheOperation> all cache operations for this method, or `null` if none found Annotations @Override @Nullable

public Collection<CacheOperation> getCacheOperations(Method method, Class<?> targetClass)

Implements org.springframework.cache.interceptor.CacheOperationSource.getCacheOperations.

Doc from org.springframework.cache.interceptor.CacheOperationSource.getCacheOperations.

Return the collection of cache operations for this method, or null if the method contains no cacheable annotations.

Parameters

method:Method: the method to introspect
targetClass:Class<?>: the target class (may be null, in which case the declaring class of the method must be used)

Returns:Collection<CacheOperation>

all cache operations for this method, or null if none found

Annotations

@Override
@Nullable

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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

isMatch back to summary

isMatch	back to summary
protected boolean isMatch(String methodName, String mappedName) Return if the given method name matches the mapped name. The default implementation checks for "xxx", "xxx" and "xxx" matches, as well as direct equality. Can be overridden in subclasses. Parameters methodName:String the method name of the class mappedName:String the name in the descriptor Returns:boolean if the names match See Also `org.springframework.util.PatternMatchUtils#simpleMatch(String, String)`

protected boolean isMatch(String methodName, String mappedName)

Return if the given method name matches the mapped name.

The default implementation checks for "xxx*", "*xxx" and "*xxx*" matches, as well as direct equality. Can be overridden in subclasses.

Parameters

methodName:String: the method name of the class
mappedName:String: the name in the descriptor

Returns:boolean

if the names match

setNameMap back to summary

setNameMap	back to summary
public void setNameMap(Map<String, Collection<CacheOperation>> nameMap) Set a name/attribute map, consisting of method names (e.g. "myMethod") and CacheOperation instances (or Strings to be converted to CacheOperation instances). See Also `CacheOperation`

public void setNameMap(Map<String, Collection<CacheOperation>> nameMap)

Set a name/attribute map, consisting of method names (e.g. "myMethod") and CacheOperation instances (or Strings to be converted to CacheOperation instances).

See Also: CacheOperation

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class NameMatchCacheOperationSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail