play.cache

Class DefaultSyncCacheApi

java.lang.Object

play.cache.DefaultSyncCacheApi

All Implemented Interfaces:

CacheApi, SyncCacheApi

public class DefaultSyncCacheApi
extends java.lang.Object
implements SyncCacheApi, CacheApi

An implementation of SyncCacheApi that wraps AsyncCacheApi

Note: this class is really not the "default" implementation of the CacheApi in Play. SyncCacheApiAdapter is actually used in the default Ehcache implementation. A better name for this class might be "BlockingSyncCacheApi" since it blocks on the futures from the async implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	awaitTimeoutMillis

Constructor Summary

Constructors

Constructor and Description
DefaultSyncCacheApi(AsyncCacheApi 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) Deprecated. Use getOrElseUpdate instead (2.6.0)
<T> T	getOrElse(java.lang.String key, java.util.concurrent.Callable<T> block, int expiration) Deprecated. Use getOrElseUpdate instead (2.6.0)
<T> T	getOrElseUpdate(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	getOrElseUpdate(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

Field Detail

awaitTimeoutMillis

protected long awaitTimeoutMillis

Constructor Detail

DefaultSyncCacheApi

@Inject
public DefaultSyncCacheApi(AsyncCacheApi cacheApi)

Method Detail

get

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

Description copied from interface: SyncCacheApi

Retrieves an object by key.

Specified by:

get in interface CacheApi

Specified by:

get in interface SyncCacheApi

Type Parameters:

T - the type of the stored object

Parameters:

key - the key to look up

Returns:

the object or null

getOrElse

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

Deprecated. Use getOrElseUpdate instead (2.6.0)

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

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

Deprecated. Use getOrElseUpdate instead (2.6.0)

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

getOrElseUpdate

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

Description copied from interface: SyncCacheApi

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

Specified by:

getOrElseUpdate in interface SyncCacheApi

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:

the value

getOrElseUpdate

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

Description copied from interface: SyncCacheApi

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

The value has no expiration.

Specified by:

getOrElseUpdate in interface SyncCacheApi

Type Parameters:

T - the type of the value

Parameters:

key - Item key.

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

Returns:

the value

set

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

Description copied from interface: SyncCacheApi

Sets a value with expiration.

Specified by:

set in interface CacheApi

Specified by:

set in interface SyncCacheApi

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: SyncCacheApi

Sets a value without expiration.

Specified by:

set in interface CacheApi

Specified by:

set in interface SyncCacheApi

Parameters:

key - Item key.

value - The value to set.

remove

public void remove(java.lang.String key)

Description copied from interface: SyncCacheApi

Removes a value from the cache.

Specified by:

remove in interface CacheApi

Specified by:

remove in interface SyncCacheApi

Parameters:

key - The key to remove the value for.