play.cache

Class DefaultCacheApi

java.lang.Object

play.cache.DefaultCacheApi

All Implemented Interfaces:

CacheApi

@Singleton
public class DefaultCacheApi
extends java.lang.Object
implements CacheApi

Constructor Summary

Constructors

Constructor and Description
DefaultCacheApi(play.api.cache.CacheApi cacheApi)

Method Summary

Modifier and Type	Method and Description
<T> T	get(java.lang.String key) Retrieves an object by key.
<T> T	getOrElse(java.lang.String key, java.util.concurrent.Callable<T> block) Retrieve a value from the cache, or set it from a default Callable function.
<T> T	getOrElse(java.lang.String key, java.util.concurrent.Callable<T> block, int expiration) Retrieve a value from the cache, or set it from a default Callable function.
void	remove(java.lang.String key) Removes a value from the cache.
void	set(java.lang.String key, java.lang.Object value) Sets a value without expiration.
void	set(java.lang.String key, java.lang.Object value, int expiration) Sets a value with expiration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCacheApi

@Inject
public DefaultCacheApi(play.api.cache.CacheApi cacheApi)

Method Detail

get

public <T> T get(java.lang.String key)

Description copied from interface: CacheApi

Retrieves an object by key.

Specified by:

get in interface CacheApi

Type Parameters:

T - the type of the stored object

Parameters:

key - the key to look up

Returns:

the object or null

getOrElse

public <T> T getOrElse(java.lang.String key,
                       java.util.concurrent.Callable<T> block,
                       int expiration)

Description copied from interface: CacheApi

Retrieve a value from the cache, or set it from a default Callable function.

Specified by:

getOrElse in interface CacheApi

Type Parameters:

T - the type of the value

Parameters:

key - Item key.

block - block returning value to set if key does not exist

expiration - expiration period in seconds.

Returns:

value

getOrElse

public <T> T getOrElse(java.lang.String key,
                       java.util.concurrent.Callable<T> block)

Description copied from interface: CacheApi

Retrieve a value from the cache, or set it from a default Callable function. The value has no expiration.

Specified by:

getOrElse in interface CacheApi

Type Parameters:

T - the type of the value

Parameters:

key - Item key.

block - block returning value to set if key does not exist

Returns:

value

set

public void set(java.lang.String key,
                java.lang.Object value,
                int expiration)

Description copied from interface: CacheApi

Sets a value with expiration.

Specified by:

set in interface CacheApi

Parameters:

key - Item key.

value - The value to set.

expiration - expiration in seconds

set

public void set(java.lang.String key,
                java.lang.Object value)

Description copied from interface: CacheApi

Sets a value without expiration.

Specified by:

set in interface CacheApi

Parameters:

key - Item key.

value - The value to set.

remove

public void remove(java.lang.String key)

Description copied from interface: CacheApi

Removes a value from the cache.

Specified by:

remove in interface CacheApi

Parameters:

key - The key to remove the value for.