Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	SpringCacheAnnotationParser.DefaultCacheConfig Provides default settings for a given set of cache operations.

Field Summary

Modifier and Type	Field and Description
private static final Set<Class<? extends Annotation>>	CACHE_OPERATION_ANNOTATIONS

Constructor Summary

Access	Constructor and Description
public	SpringCacheAnnotationParser()

Method Summary

Modifier and Type	Method and Description
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 boolean	isCandidateClass(Class<?> the class to introspect targetClass) Overrides default org.springframework.cache.annotation.CacheAnnotationParser.isCandidateClass. Determine whether the given class is a candidate for cache operations in the annotation format of this `CacheAnnotationParser`.
private CacheableOperation	parseCacheableAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, Cacheable cacheable)
public Collection<CacheOperation>	parseCacheAnnotations(Class<?> the annotated class type) Implements org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations. Parse the cache definition for the given class, based on an annotation type understood by this parser.
public Collection<CacheOperation>	parseCacheAnnotations(Method the annotated method method) Implements org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations. Parse the cache definition for the given method, based on an annotation type understood by this parser.
private Collection<CacheOperation>	parseCacheAnnotations(SpringCacheAnnotationParser.DefaultCacheConfig cachingConfig, AnnotatedElement ae)
private Collection<CacheOperation>	parseCacheAnnotations(SpringCacheAnnotationParser.DefaultCacheConfig cachingConfig, AnnotatedElement ae, boolean localOnly)
private void	parseCachingAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, Caching caching, Collection<CacheOperation> ops)
private CacheEvictOperation	parseEvictAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, CacheEvict cacheEvict)
private CacheOperation	parsePutAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, CachePut cachePut)
private void	validateCacheOperation(AnnotatedElement the annotated element of the cache operation ae, CacheOperation the `CacheOperation` to validate operation) Validates the specified `CacheOperation`.

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

Field Detail

CACHE_OPERATION_ANNOTATIONS	back to summary
private static final Set<Class<? extends Annotation>> CACHE_OPERATION_ANNOTATIONS

Constructor Detail

SpringCacheAnnotationParser	back to summary
public SpringCacheAnnotationParser()

Method Detail

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

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

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

isCandidateClass back to summary

isCandidateClass	back to summary
public boolean isCandidateClass(Class<?> targetClass) Overrides default org.springframework.cache.annotation.CacheAnnotationParser.isCandidateClass. Doc from org.springframework.cache.annotation.CacheAnnotationParser.isCandidateClass. Determine whether the given class is a candidate for cache operations in the annotation format of this `CacheAnnotationParser`. If this method returns `false`, the methods on the given class will not get traversed for `#parseCacheAnnotations` 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 annotations 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.annotation.CacheAnnotationParser.isCandidateClass.

Doc from org.springframework.cache.annotation.CacheAnnotationParser.isCandidateClass.

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

If this method returns false, the methods on the given class will not get traversed for #parseCacheAnnotations 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 annotations at class or method level; true otherwise. The default implementation returns true, leading to regular introspection.

Annotations

@Override

parseCacheableAnnotation	back to summary
private CacheableOperation parseCacheableAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, Cacheable cacheable)

parseCacheAnnotations back to summary

parseCacheAnnotations	back to summary
public Collection<CacheOperation> parseCacheAnnotations(Class<?> type) Implements org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations. Doc from org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations. Parse the cache definition for the given class, based on an annotation type understood by this parser. This essentially parses a known cache annotation into Spring's metadata attribute class. Returns `null` if the class is not cacheable. Parameters type:Class<?> the annotated class Returns:Collection<CacheOperation> the configured caching operation, or `null` if none found Annotations @Override @Nullable

public Collection<CacheOperation> parseCacheAnnotations(Class<?> type)

Implements org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations.

Doc from org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations.

Parse the cache definition for the given class, based on an annotation type understood by this parser.

This essentially parses a known cache annotation into Spring's metadata attribute class. Returns null if the class is not cacheable.

Parameters

type:Class<?>: the annotated class

Returns:Collection<CacheOperation>

the configured caching operation, or null if none found

Annotations

@Override
@Nullable

parseCacheAnnotations back to summary

parseCacheAnnotations	back to summary
public Collection<CacheOperation> parseCacheAnnotations(Method method) Implements org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations. Doc from org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations. Parse the cache definition for the given method, based on an annotation type understood by this parser. This essentially parses a known cache annotation into Spring's metadata attribute class. Returns `null` if the method is not cacheable. Parameters method:Method the annotated method Returns:Collection<CacheOperation> the configured caching operation, or `null` if none found Annotations @Override @Nullable

public Collection<CacheOperation> parseCacheAnnotations(Method method)

Implements org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations.

Doc from org.springframework.cache.annotation.CacheAnnotationParser.parseCacheAnnotations.

Parse the cache definition for the given method, based on an annotation type understood by this parser.

This essentially parses a known cache annotation into Spring's metadata attribute class. Returns null if the method is not cacheable.

Parameters

method:Method: the annotated method

Returns:Collection<CacheOperation>

the configured caching operation, or null if none found

Annotations

@Override
@Nullable

parseCacheAnnotations	back to summary
private Collection<CacheOperation> parseCacheAnnotations(SpringCacheAnnotationParser.DefaultCacheConfig cachingConfig, AnnotatedElement ae) Annotations @Nullable

parseCacheAnnotations	back to summary
private Collection<CacheOperation> parseCacheAnnotations(SpringCacheAnnotationParser.DefaultCacheConfig cachingConfig, AnnotatedElement ae, boolean localOnly) Annotations @Nullable

parseCachingAnnotation	back to summary
private void parseCachingAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, Caching caching, Collection<CacheOperation> ops)

parseEvictAnnotation	back to summary
private CacheEvictOperation parseEvictAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, CacheEvict cacheEvict)

parsePutAnnotation	back to summary
private CacheOperation parsePutAnnotation(AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, CachePut cachePut)

validateCacheOperation back to summary

validateCacheOperation	back to summary
private void validateCacheOperation(AnnotatedElement ae, CacheOperation operation) Validates the specified `CacheOperation`. Throws an `IllegalStateException` if the state of the operation is invalid. As there might be multiple sources for default values, this ensures that the operation is in a proper state before being returned. Parameters ae:AnnotatedElement the annotated element of the cache operation operation:CacheOperation the `CacheOperation` to validate

private void validateCacheOperation(AnnotatedElement ae, CacheOperation operation)

Validates the specified CacheOperation.

Throws an IllegalStateException if the state of the operation is invalid. As there might be multiple sources for default values, this ensures that the operation is in a proper state before being returned.

Parameters

ae:AnnotatedElement: the annotated element of the cache operation
operation:CacheOperation: the CacheOperation to validate

org.springframework.cache.annotation back to summary

private Class SpringCacheAnnotationParser.DefaultCacheConfig

Class Inheritance

extends Object

java.lang.Object
org.springframework.cache.annotation.SpringCacheAnnotationParser.DefaultCacheConfig

Provides default settings for a given set of cache operations.

Field Summary

Modifier and Type	Field and Description
private String	cacheManager
private String[]	cacheNames
private String	cacheResolver
private boolean	initialized
private String	keyGenerator
private final Class<?>	target

Constructor Summary

Access	Constructor and Description
public	DefaultCacheConfig(Class<?> target)

Method Summary

Modifier and Type	Method and Description
public void	applyDefault(CacheOperation.Builder the operation builder to update builder) Apply the defaults to the specified `CacheOperation.Builder`.

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

Field Detail

cacheManager	back to summary
private String cacheManager Annotations @Nullable

cacheNames	back to summary
private String[] cacheNames Annotations @Nullable

cacheResolver	back to summary
private String cacheResolver Annotations @Nullable

initialized	back to summary
private boolean initialized

keyGenerator	back to summary
private String keyGenerator Annotations @Nullable

target	back to summary
private final Class<?> target

Constructor Detail

DefaultCacheConfig	back to summary
public DefaultCacheConfig(Class<?> target)

Method Detail

applyDefault back to summary

applyDefault	back to summary
public void applyDefault(CacheOperation.Builder builder) Apply the defaults to the specified `CacheOperation.Builder`. Parameters builder:CacheOperation.Builder the operation builder to update

public void applyDefault(CacheOperation.Builder builder)

Apply the defaults to the specified CacheOperation.Builder.

Parameters

builder:CacheOperation.Builder: the operation builder to update

public Class SpringCacheAnnotationParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SpringCacheAnnotationParser.DefaultCacheConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail