Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static interface	AnnotationCacheOperationSource.CacheOperationProvider Callback interface providing `CacheOperation` instance(s) based on a given `CacheAnnotationParser`.

Field Summary

Modifier and Type	Field and Description
private final Set<CacheAnnotationParser>	annotationParsers
private final boolean	publicMethodsOnly

Inherited from org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource:: logger

Constructor Summary

Access	Constructor and Description
public	AnnotationCacheOperationSource() Create a default AnnotationCacheOperationSource, supporting public methods that carry the `Cacheable` and `CacheEvict` annotations.
public	AnnotationCacheOperationSource(boolean whether to support only annotated public methods typically for use with proxy-based AOP), or protected/private methods as well (typically used with AspectJ class weaving) publicMethodsOnly) Create a default `AnnotationCacheOperationSource`, supporting public methods that carry the `Cacheable` and `CacheEvict` annotations.
public	AnnotationCacheOperationSource(CacheAnnotationParser the CacheAnnotationParser to use annotationParser) Create a custom AnnotationCacheOperationSource.
public	AnnotationCacheOperationSource(CacheAnnotationParser... the CacheAnnotationParser to use annotationParsers) Create a custom AnnotationCacheOperationSource.
public	AnnotationCacheOperationSource(Set<CacheAnnotationParser> the CacheAnnotationParser to use annotationParsers) Create a custom AnnotationCacheOperationSource.

Method Summary

Modifier and Type	Method and Description
protected boolean	allowPublicMethodsOnly() Overrides org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.allowPublicMethodsOnly. By default, only public methods can be made cacheable.
protected Collection<CacheOperation>	Returns: the configured caching operations, or `null` if none found determineCacheOperations(AnnotationCacheOperationSource.CacheOperationProvider the cache operation provider to use provider) Determine the cache operation(s) for the given `CacheOperationProvider`.
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.
protected Collection<CacheOperation>	findCacheOperations(Class<?> the class to retrieve the attribute for clazz) Implements abstract org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations. Subclasses need to implement this to return the caching attribute for the given class, if any.
protected Collection<CacheOperation>	findCacheOperations(Method the method to retrieve the attribute for method) Implements abstract org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations. Subclasses need to implement this to return the caching attribute for the given method, if any.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isCandidateClass(Class<?> the class to introspect targetClass) Overrides default org.springframework.cache.interceptor.CacheOperationSource.isCandidateClass. Determine whether the given class is a candidate for cache operations in the metadata format of this `CacheOperationSource`.

Inherited from org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource:: getCacheKey getCacheOperations

Field Detail

annotationParsers	back to summary
private final Set<CacheAnnotationParser> annotationParsers

publicMethodsOnly	back to summary
private final boolean publicMethodsOnly

Constructor Detail

AnnotationCacheOperationSource	back to summary
public AnnotationCacheOperationSource() Create a default AnnotationCacheOperationSource, supporting public methods that carry the `Cacheable` and `CacheEvict` annotations.

AnnotationCacheOperationSource back to summary

AnnotationCacheOperationSource	back to summary
public AnnotationCacheOperationSource(boolean publicMethodsOnly) Create a default `AnnotationCacheOperationSource`, supporting public methods that carry the `Cacheable` and `CacheEvict` annotations. Parameters publicMethodsOnly:boolean whether to support only annotated public methods typically for use with proxy-based AOP), or protected/private methods as well (typically used with AspectJ class weaving)

public AnnotationCacheOperationSource(boolean publicMethodsOnly)

Create a default AnnotationCacheOperationSource, supporting public methods that carry the Cacheable and CacheEvict annotations.

Parameters

publicMethodsOnly:boolean: whether to support only annotated public methods typically for use with proxy-based AOP), or protected/private methods as well (typically used with AspectJ class weaving)

AnnotationCacheOperationSource	back to summary
public AnnotationCacheOperationSource(CacheAnnotationParser annotationParser) Create a custom AnnotationCacheOperationSource. Parameters annotationParser:CacheAnnotationParser the CacheAnnotationParser to use

AnnotationCacheOperationSource

back to summary

public AnnotationCacheOperationSource(CacheAnnotationParser annotationParser)

Create a custom AnnotationCacheOperationSource.

Parameters

annotationParser:CacheAnnotationParser: the CacheAnnotationParser to use

AnnotationCacheOperationSource	back to summary
public AnnotationCacheOperationSource(CacheAnnotationParser... annotationParsers) Create a custom AnnotationCacheOperationSource. Parameters annotationParsers:CacheAnnotationParser[] the CacheAnnotationParser to use

AnnotationCacheOperationSource

back to summary

public AnnotationCacheOperationSource(CacheAnnotationParser... annotationParsers)

Create a custom AnnotationCacheOperationSource.

Parameters

annotationParsers:CacheAnnotationParser[]: the CacheAnnotationParser to use

AnnotationCacheOperationSource	back to summary
public AnnotationCacheOperationSource(Set<CacheAnnotationParser> annotationParsers) Create a custom AnnotationCacheOperationSource. Parameters annotationParsers:Set<CacheAnnotationParser> the CacheAnnotationParser to use

AnnotationCacheOperationSource

back to summary

public AnnotationCacheOperationSource(Set<CacheAnnotationParser> annotationParsers)

Create a custom AnnotationCacheOperationSource.

Parameters

annotationParsers:Set<CacheAnnotationParser>: the CacheAnnotationParser to use

Method Detail

allowPublicMethodsOnly	back to summary
protected boolean allowPublicMethodsOnly() Overrides org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.allowPublicMethodsOnly. By default, only public methods can be made cacheable. Annotations @Override

allowPublicMethodsOnly

back to summary

protected boolean allowPublicMethodsOnly()

Overrides org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.allowPublicMethodsOnly.

By default, only public methods can be made cacheable.

Annotations

@Override

determineCacheOperations back to summary

determineCacheOperations	back to summary
protected Collection<CacheOperation> determineCacheOperations(AnnotationCacheOperationSource.CacheOperationProvider provider) Determine the cache operation(s) for the given `CacheOperationProvider`. This implementation delegates to configured `CacheAnnotationParsers` for parsing known annotations into Spring's metadata attribute class. Can be overridden to support custom annotations that carry caching metadata. Parameters provider:AnnotationCacheOperationSource.CacheOperationProvider the cache operation provider to use Returns:Collection<CacheOperation> the configured caching operations, or `null` if none found Annotations @Nullable

protected Collection<CacheOperation> determineCacheOperations(AnnotationCacheOperationSource.CacheOperationProvider provider)

Determine the cache operation(s) for the given CacheOperationProvider.

This implementation delegates to configured CacheAnnotationParsers for parsing known annotations into Spring's metadata attribute class.

Can be overridden to support custom annotations that carry caching metadata.

Parameters

provider:AnnotationCacheOperationSource.CacheOperationProvider: the cache operation provider to use

Returns:Collection<CacheOperation>

the configured caching operations, or null if none found

Annotations

@Nullable

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

findCacheOperations back to summary

findCacheOperations	back to summary
protected Collection<CacheOperation> findCacheOperations(Class<?> clazz) Implements abstract org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations. Doc from org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations. Subclasses need to implement this to return the caching attribute for the given class, if any. Parameters clazz:Class<?> the class to retrieve the attribute for Returns:Collection<CacheOperation> all caching attribute associated with this class, or `null` if none Annotations @Override @Nullable

protected Collection<CacheOperation> findCacheOperations(Class<?> clazz)

Implements abstract org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations.

Doc from org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations.

Subclasses need to implement this to return the caching attribute for the given class, if any.

Parameters

clazz:Class<?>: the class to retrieve the attribute for

Returns:Collection<CacheOperation>

all caching attribute associated with this class, or null if none

Annotations

@Override
@Nullable

findCacheOperations back to summary

findCacheOperations	back to summary
protected Collection<CacheOperation> findCacheOperations(Method method) Implements abstract org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations. Doc from org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations. Subclasses need to implement this to return the caching attribute for the given method, if any. Parameters method:Method the method to retrieve the attribute for Returns:Collection<CacheOperation> all caching attribute associated with this method, or `null` if none Annotations @Override @Nullable

protected Collection<CacheOperation> findCacheOperations(Method method)

Implements abstract org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations.

Doc from org.springframework.cache.interceptor.AbstractFallbackCacheOperationSource.findCacheOperations.

Subclasses need to implement this to return the caching attribute for the given method, if any.

Parameters

method:Method: the method to retrieve the attribute for

Returns:Collection<CacheOperation>

all caching attribute associated with this method, or null if none

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

isCandidateClass back to summary

isCandidateClass	back to summary
public boolean isCandidateClass(Class<?> targetClass) Overrides default org.springframework.cache.interceptor.CacheOperationSource.isCandidateClass. Doc from org.springframework.cache.interceptor.CacheOperationSource.isCandidateClass. Determine whether the given class is a candidate for cache operations in the metadata format of this `CacheOperationSource`. If this method returns `false`, the methods on the given class will not get traversed for `getCacheOperations` introspection. Returning `false` is therefore an optimization for non-affected classes, whereas `true` simply means that the class needs to get fully introspected for each method on the given class individually. Parameters targetClass:Class<?> the class to introspect Returns:boolean `false` if the class is known to have no cache operation metadata at class or method level; `true` otherwise. The default implementation returns `true`, leading to regular introspection. Annotations @Override

public boolean isCandidateClass(Class<?> targetClass)

Overrides default org.springframework.cache.interceptor.CacheOperationSource.isCandidateClass.

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

Determine whether the given class is a candidate for cache operations in the metadata format of this CacheOperationSource.

If this method returns false, the methods on the given class will not get traversed for getCacheOperations introspection. Returning false is therefore an optimization for non-affected classes, whereas true simply means that the class needs to get fully introspected for each method on the given class individually.

Parameters

targetClass:Class<?>: the class to introspect

Returns:boolean

false if the class is known to have no cache operation metadata at class or method level; true otherwise. The default implementation returns true, leading to regular introspection.

Annotations

@Override

org.springframework.cache.annotation back to summary

protected Interface AnnotationCacheOperationSource.CacheOperationProvider

Annotations

@FunctionalInterface

Callback interface providing CacheOperation instance(s) based on a given CacheAnnotationParser.

Method Summary

Modifier and Type	Method and Description
public Collection<CacheOperation>	Returns: the cache operations, or `null` if none found getCacheOperations(CacheAnnotationParser the parser to use parser) Return the `CacheOperation` instance(s) provided by the specified parser.

Method Detail

getCacheOperations back to summary

getCacheOperations	back to summary
public Collection<CacheOperation> getCacheOperations(CacheAnnotationParser parser) Return the `CacheOperation` instance(s) provided by the specified parser. Parameters parser:CacheAnnotationParser the parser to use Returns:Collection<CacheOperation> the cache operations, or `null` if none found Annotations @Nullable

public Collection<CacheOperation> getCacheOperations(CacheAnnotationParser parser)

Return the CacheOperation instance(s) provided by the specified parser.

Parameters

parser:CacheAnnotationParser: the parser to use

Returns:Collection<CacheOperation>

the cache operations, or null if none found

Annotations

@Nullable

public Class AnnotationCacheOperationSource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Interface AnnotationCacheOperationSource.CacheOperationProvider

Method Summary

Method Detail