org.springframework.cache.annotation

Class SpringCacheAnnotationParser

java.lang.Object

org.springframework.cache.annotation.SpringCacheAnnotationParser

All Implemented Interfaces:

java.io.Serializable, CacheAnnotationParser

public class SpringCacheAnnotationParser
extends java.lang.Object
implements CacheAnnotationParser, java.io.Serializable

Strategy implementation for parsing Spring's Caching, Cacheable, CacheEvict, and CachePut annotations.

Since:

3.1

Author:

Costin Leau, Juergen Hoeller, Chris Beams, Phillip Webb, Stephane Nicoll, Sam Brannen

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SpringCacheAnnotationParser()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
private <A extends java.lang.annotation.Annotation> java.util.Collection<A>	getAnnotations(java.lang.reflect.AnnotatedElement ae, java.lang.Class<A> annotationType)
(package private) SpringCacheAnnotationParser.DefaultCacheConfig	getDefaultCacheConfig(java.lang.Class<?> target) Provides the SpringCacheAnnotationParser.DefaultCacheConfig instance for the specified Class.
int	hashCode()
private <T extends java.lang.annotation.Annotation> java.util.Collection<CacheOperation>	lazyInit(java.util.Collection<CacheOperation> ops)
(package private) CacheableOperation	parseCacheableAnnotation(java.lang.reflect.AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, Cacheable cacheable)
java.util.Collection<CacheOperation>	parseCacheAnnotations(java.lang.Class<?> type) Parses the cache definition for the given class, based on a known annotation type.
java.util.Collection<CacheOperation>	parseCacheAnnotations(java.lang.reflect.Method method) Parses the cache definition for the given method, based on a known annotation type.
protected java.util.Collection<CacheOperation>	parseCacheAnnotations(SpringCacheAnnotationParser.DefaultCacheConfig cachingConfig, java.lang.reflect.AnnotatedElement ae)
(package private) java.util.Collection<CacheOperation>	parseCachingAnnotation(java.lang.reflect.AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, Caching caching)
(package private) CacheEvictOperation	parseEvictAnnotation(java.lang.reflect.AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, CacheEvict cacheEvict)
(package private) CacheOperation	parsePutAnnotation(java.lang.reflect.AnnotatedElement ae, SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig, CachePut cachePut)
private void	validateCacheOperation(java.lang.reflect.AnnotatedElement ae, CacheOperation operation) Validates the specified CacheOperation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringCacheAnnotationParser

public SpringCacheAnnotationParser()

Method Detail

parseCacheAnnotations

public java.util.Collection<CacheOperation> parseCacheAnnotations(java.lang.Class<?> type)

Description copied from interface: CacheAnnotationParser

Parses the cache definition for the given class, based on a known annotation type.

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

Specified by:

parseCacheAnnotations in interface CacheAnnotationParser

Parameters:

type - the annotated class

Returns:

CacheOperation the configured caching operation, or null if none was found

See Also:

AnnotationCacheOperationSource.findCacheOperations(Class)

parseCacheAnnotations

public java.util.Collection<CacheOperation> parseCacheAnnotations(java.lang.reflect.Method method)

Description copied from interface: CacheAnnotationParser

Parses the cache definition for the given method, based on a known annotation type.

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

Specified by:

parseCacheAnnotations in interface CacheAnnotationParser

Parameters:

method - the annotated method

Returns:

CacheOperation the configured caching operation, or null if none was found

See Also:

AnnotationCacheOperationSource.findCacheOperations(Method)

parseCacheAnnotations

protected java.util.Collection<CacheOperation> parseCacheAnnotations(SpringCacheAnnotationParser.DefaultCacheConfig cachingConfig,
                                                                     java.lang.reflect.AnnotatedElement ae)

lazyInit

private <T extends java.lang.annotation.Annotation> java.util.Collection<CacheOperation> lazyInit(java.util.Collection<CacheOperation> ops)

parseCacheableAnnotation

CacheableOperation parseCacheableAnnotation(java.lang.reflect.AnnotatedElement ae,
                                            SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig,
                                            Cacheable cacheable)

parseEvictAnnotation

CacheEvictOperation parseEvictAnnotation(java.lang.reflect.AnnotatedElement ae,
                                         SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig,
                                         CacheEvict cacheEvict)

parsePutAnnotation

CacheOperation parsePutAnnotation(java.lang.reflect.AnnotatedElement ae,
                                  SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig,
                                  CachePut cachePut)

parseCachingAnnotation

java.util.Collection<CacheOperation> parseCachingAnnotation(java.lang.reflect.AnnotatedElement ae,
                                                            SpringCacheAnnotationParser.DefaultCacheConfig defaultConfig,
                                                            Caching caching)

getDefaultCacheConfig

SpringCacheAnnotationParser.DefaultCacheConfig getDefaultCacheConfig(java.lang.Class<?> target)

Provides the SpringCacheAnnotationParser.DefaultCacheConfig instance for the specified Class.

Parameters:

target - the class-level to handle

Returns:

the default config (never null)

getAnnotations

private <A extends java.lang.annotation.Annotation> java.util.Collection<A> getAnnotations(java.lang.reflect.AnnotatedElement ae,
                                                                                           java.lang.Class<A> annotationType)

validateCacheOperation

private void validateCacheOperation(java.lang.reflect.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 ensure that the operation is in a proper state before being returned.

Parameters:

ae - the annotated element of the cache operation

operation - the CacheOperation to validate

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object