com.alicp.jetcache.anno

Annotation Type Cached

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Cached

Author:

huangli

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.
boolean	cacheNullValue Specify whether a null value should be cached.
CacheType	cacheType Type of the Cache instance.
String	condition Expression script used for conditioning the method caching, the cache is not used when evaluation result is false.
boolean	enabled Specify whether the method caching is enabled.
int	expire The expire time.
String	key Specify the key by expression script, optional.
String	keyConvertor Specify the key convertor.
int	localExpire Use to specify the local cache expire time when cacheType=CacheType.BOTH, use "expire" if absent.
int	localLimit Specify max elements in local memory when cacheType is CacheType.LOCAL or CacheType.BOTH.
String	name The name of this Cache instance, optional.
String	postCondition Expression script used for conditioning the method cache updating, the cache updating action is vetoed when the evaluation result is false.
String	serialPolicy Specify the serialization policy of remote cache when cacheType is CacheType.REMOTE or CacheType.BOTH.
TimeUnit	timeUnit Specify the time unit of expire.

Element Detail

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"

name

public abstract String name

The name of this Cache instance, optional. If you do not specify, JetCache will auto generate one. The name is used to display statistics information and as part of key prefix when using a remote cache. Do not assign same name to different @Cached annotation which with same area.

Returns:

the name of the cache

Default:

"$$undefined$$"

enabled

public abstract boolean enabled

Specify whether the method caching is enabled. If set to false, you can enable it in thread context using CacheContext.enableCache(Supplier<T> callback)

Returns:

if the method cache is enabled

Default:

true

timeUnit

public abstract TimeUnit timeUnit

Specify the time unit of expire.

Returns:

the time unit of expire time

Default:

java.util.concurrent.TimeUnit.SECONDS

expire

public abstract int expire

The expire time. Use global config if the attribute value is absent, and if the global config is not defined either, use infinity instead.

Returns:

the expire time

Default:

-2147483648

localExpire

public abstract int localExpire

Use to specify the local cache expire time when cacheType=CacheType.BOTH, use "expire" if absent.

Returns:

the local cache expire time

Default:

-2147483648

cacheType

public abstract CacheType cacheType

Type of the Cache instance. May be CacheType.REMOTE, CacheType.LOCAL, CacheType.BOTH. Create a two level cache (local+remote) when value is CacheType.BOTH.

Returns:

cache type of the method cache

Default:

com.alicp.jetcache.anno.CacheType.REMOTE

localLimit

public abstract int localLimit

Specify max elements in local memory when cacheType is CacheType.LOCAL or CacheType.BOTH. Use global config if the attribute value is absent, and if the global config is not defined either, use CacheConsts.DEFAULT_LOCAL_LIMIT instead.

Returns:

local maximal elements of the LOCAL/BOTH cache

Default:

-2147483648

serialPolicy

public abstract String serialPolicy

Specify the serialization policy of remote cache when cacheType is CacheType.REMOTE or CacheType.BOTH. The JetCache build-in serialPolicy are SerialPolicy.JAVA or SerialPolicy.KRYO. Use global config if the attribute value is absent, and if the global config is not defined either, use SerialPolicy.JAVA instead.

Returns:

the serialization policy name of cache value

Default:

"$$undefined$$"

keyConvertor

public abstract String keyConvertor

Specify the key convertor. Used to convert the complex key object. The JetCache build-in keyConvertor are KeyConvertor.FASTJSON or KeyConvertor.NONE. NONE indicate do not convert, FASTJSON will use fastjson to convert key object to a string. Use global config if the attribute value is absent.

Returns:

convertor name of cache key

Default:

"$$undefined$$"

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

cacheNullValue

public abstract boolean cacheNullValue

Specify whether a null value should be cached.

Returns:

whether a null value should be cached

Default:

false

condition

public abstract String condition

Expression script used for conditioning the method caching, the cache is not used when evaluation result is false. Evaluation occurs before real method invocation.

Default:

"$$undefined$$"

postCondition

public abstract String postCondition

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

Default:

"$$undefined$$"