com.alicp.jetcache.anno

Annotation Type CacheInvalidate

@Documented
 @Retention(value=RUNTIME)
 @Repeatable(value=CacheInvalidateContainer.class)
 @Target(value=METHOD)
public @interface CacheInvalidate

Author:

huangli

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of this Cache instance which need a remove operation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	area If you want to use multi backend cache system, you can setup multi "cache area" in configuration, this attribute specifies the name of the "cache area" you want to use.
String	condition Expression script used for conditioning the cache operation, the operation is vetoed when evaluation result is false.
String	key Specify the key by expression script, optional.
boolean	multi If evaluated key is an array or an instance of java.lang.Iterable, set multi to true indicates jetcache to invalidate each element of the iterable keys.

Element Detail

name

public abstract String name

The name of this Cache instance which need a remove operation.

Returns:

the name of the cache which need a remove operation

area

public abstract String area

If you want to use multi backend cache system, you can setup multi "cache area" in configuration, this attribute specifies the name of the "cache area" you want to use.

Returns:

the name of cache area

Default:

"default"

key

public abstract String key

Specify the key by expression script, optional. If not specified, use all parameters of the target method and keyConvertor to generate one.

Returns:

an expression script which specifies key

Default:

"$$undefined$$"

condition

public abstract String condition

Expression script used for conditioning the cache operation, the operation is vetoed when evaluation result is false. Evaluation occurs after real method invocation so we can refer #result in script.

Default:

"$$undefined$$"

multi

public abstract boolean multi

If evaluated key is an array or an instance of java.lang.Iterable, set multi to true indicates jetcache to invalidate each element of the iterable keys.

Default:

false