io.micronaut.cache.annotation

Annotation Type CacheInvalidate

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @CacheConfig
 @Type(value=CacheInterceptor.class)
 @Repeatable(value=InvalidateOperations.class)
public @interface CacheInvalidate

An annotation that can be applied at the type or method level to indicate that the annotated operation should cause the eviction of the given caches.

Since:

1.0

Author:

Graeme Rocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	all
boolean	async Whether the cache operation should be performed asynchronously and not block the returning value.
java.lang.String[]	cacheNames Alias for CacheConfig.cacheNames().
java.lang.Class<? extends CacheKeyGenerator>	keyGenerator Alias for CacheConfig.keyGenerator().
java.lang.String[]	parameters Limit the automatic CacheKeyGenerator to the given parameter names.
java.lang.String[]	value Alias for CacheConfig.cacheNames().

Element Detail

value

@AliasFor(member="cacheNames")
public abstract java.lang.String[] value

Alias for CacheConfig.cacheNames().

Returns:

Cache names

Default:

{}

cacheNames

@AliasFor(annotation=CacheConfig.class,
          member="cacheNames")
public abstract java.lang.String[] cacheNames

Alias for CacheConfig.cacheNames().

Returns:

Cache names

Default:

{}

keyGenerator

@AliasFor(annotation=CacheConfig.class,
          member="keyGenerator")
public abstract java.lang.Class<? extends CacheKeyGenerator> keyGenerator

Alias for CacheConfig.keyGenerator().

Returns:

The key generator class

Default:

io.micronaut.cache.interceptor.DefaultCacheKeyGenerator.class

parameters

public abstract java.lang.String[] parameters

Limit the automatic CacheKeyGenerator to the given parameter names. Mutually exclusive with keyGenerator()

Returns:

The parameter names that make up the key.

Default:

{}

all

public abstract boolean all

Returns:

Whether all values within the cache should be evicted or only those for the generated key

Default:

false

async

public abstract boolean async

Whether the cache operation should be performed asynchronously and not block the returning value. Note that when set to true then any cache errors will not be propagated back to the client and will simply be logged by default unless the return value itself is a non-blocking type such as CompletableFuture.

Returns:

True if should be done asynchronously

Default:

false