Cache (Play! API)

java.lang.Object
- play.cache.Cache

```
public abstract class Cache
extends Object
```
The Cache. Mainly an interface to memcached or EhCache. Note: When specifying expiration == "0s" (zero seconds) the actual expiration-time may vary between different cache implementations

Field Summary

Fields
Modifier and Type	Field and Description
`static CacheImpl`	`cacheImpl` The underlying cache implementation
`static CacheImpl`	`forcedCacheImpl` Sometime we REALLY need to change the implementation :)

Constructor Summary

Constructors
Constructor and Description

Cache()

Constructors
Constructor and Description
`Cache()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`add(String key, Object value)` Add an element only if it doesn't exist and store it indefinitely.
`static void`	`add(String key, Object value, String expiration)` Add an element only if it doesn't exist.
`static void`	`clear()` Clear all data from cache.
`static long`	`decr(String key)` Decrement the element value (must be a Number) by 1.
`static long`	`decr(String key, int by)` Decrement the element value (must be a Number).
`static void`	`delete(String key)` Delete an element from the cache.
`static Map<String,Object>`	`get(String... key)` Bulk retrieve.
`static Object`	`get(String key)` Retrieve an object.
`static <T> T`	`get(String key, Class<T> clazz)` Convenient clazz to get a value a class type;
`static long`	`incr(String key)` Increment the element value (must be a Number) by 1.
`static long`	`incr(String key, int by)` Increment the element value (must be a Number).
`static void`	`init()` Initialize the cache system.
`static void`	`replace(String key, Object value)` Replace an element only if it already exists and store it indefinitely.
`static void`	`replace(String key, Object value, String expiration)` Replace an element only if it already exists.
`static boolean`	`safeAdd(String key, Object value, String expiration)` Add an element only if it doesn't exist, and return only when the element is effectively cached.
`static boolean`	`safeDelete(String key)` Delete an element from the cache and return only when the element is effectively removed.
`static boolean`	`safeReplace(String key, Object value, String expiration)` Replace an element only if it already exists and return only when the element is effectively cached.
`static boolean`	`safeSet(String key, Object value, String expiration)` Set an element and return only when the element is effectively cached.
`static void`	`set(String key, Object value)` Set an element and store it indefinitely.
`static void`	`set(String key, Object value, String expiration)` Set an element.
`static void`	`stop()` Stop the cache system.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - cacheImpl
```
public static CacheImpl cacheImpl
```
    The underlying cache implementation
  - forcedCacheImpl
```
public static CacheImpl forcedCacheImpl
```
    Sometime we REALLY need to change the implementation :)
- Constructor Detail
  - Cache
```
public Cache()
```
- Method Detail
  - add
```
public static void add(String key,
       Object value,
       String expiration)
```
    Add an element only if it doesn't exist.
    
    Parameters:
    key - Element key
    value - Element value
    expiration - Ex: 10s, 3mn, 8h
  - safeAdd
```
public static boolean safeAdd(String key,
              Object value,
              String expiration)
```
    Add an element only if it doesn't exist, and return only when the element is effectively cached.
    
    Parameters:
    key - Element key
    value - Element value
    expiration - Ex: 10s, 3mn, 8h
    
    Returns:
    If the element an eventually been cached
  - add
```
public static void add(String key,
       Object value)
```
    Add an element only if it doesn't exist and store it indefinitely.
    
    Parameters:
    key - Element key
    value - Element value
  - set
```
public static void set(String key,
       Object value,
       String expiration)
```
    Set an element.
    
    Parameters:
    key - Element key
    value - Element value
    expiration - Ex: 10s, 3mn, 8h
  - safeSet
```
public static boolean safeSet(String key,
              Object value,
              String expiration)
```
    Set an element and return only when the element is effectively cached.
    
    Parameters:
    key - Element key
    value - Element value
    expiration - Ex: 10s, 3mn, 8h
    
    Returns:
    If the element an eventually been cached
  - set
```
public static void set(String key,
       Object value)
```
    Set an element and store it indefinitely.
    
    Parameters:
    key - Element key
    value - Element value
  - replace
```
public static void replace(String key,
           Object value,
           String expiration)
```
    Replace an element only if it already exists.
    
    Parameters:
    key - Element key
    value - Element value
    expiration - Ex: 10s, 3mn, 8h
  - safeReplace
```
public static boolean safeReplace(String key,
                  Object value,
                  String expiration)
```
    Replace an element only if it already exists and return only when the element is effectively cached.
    
    Parameters:
    key - Element key
    value - Element value
    expiration - Ex: 10s, 3mn, 8h
    
    Returns:
    If the element an eventually been cached
  - replace
```
public static void replace(String key,
           Object value)
```
    Replace an element only if it already exists and store it indefinitely.
    
    Parameters:
    key - Element key
    value - Element value
  - incr
```
public static long incr(String key,
        int by)
```
    Increment the element value (must be a Number).
    
    Parameters:
    key - Element key
    by - The incr value
    
    Returns:
    The new value
  - incr
```
public static long incr(String key)
```
    Increment the element value (must be a Number) by 1.
    
    Parameters:
    key - Element key
    
    Returns:
    The new value
  - decr
```
public static long decr(String key,
        int by)
```
    Decrement the element value (must be a Number).
    
    Parameters:
    key - Element key
    by - The decr value
    
    Returns:
    The new value
  - decr
```
public static long decr(String key)
```
    Decrement the element value (must be a Number) by 1.
    
    Parameters:
    key - Element key
    
    Returns:
    The new value
  - get
```
public static Object get(String key)
```
    Retrieve an object.
    
    Parameters:
    key - The element key
    
    Returns:
    The element value or null
  - get
```
public static Map<String,Object> get(String... key)
```
    Bulk retrieve.
    
    Parameters:
    key - List of keys
    
    Returns:
    Map of keys & values
  - delete
```
public static void delete(String key)
```
    Delete an element from the cache.
    
    Parameters:
    key - The element key
  - safeDelete
```
public static boolean safeDelete(String key)
```
    Delete an element from the cache and return only when the element is effectively removed.
    
    Parameters:
    key - The element key
    
    Returns:
    If the element an eventually been deleted
  - clear
```
public static void clear()
```
    Clear all data from cache.
  - get
```
public static <T> T get(String key,
        Class<T> clazz)
```
    Convenient clazz to get a value a class type;
    
    Type Parameters:
    T - The needed type
    Parameters:
    key - The element key
    clazz - The type class
    
    Returns:
    The element value or null
  - init
```
public static void init()
```
    Initialize the cache system.
  - stop
```
public static void stop()
```
    Stop the cache system.

Class Cache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cacheImpl

forcedCacheImpl

Constructor Detail

Cache

Method Detail

add

safeAdd

add

set

safeSet

set

replace

safeReplace

replace

incr

incr

decr

decr

get

get

delete

safeDelete

clear

get

init

stop