java.lang.Object
- ninja.cache.CacheEhCacheImpl

All Implemented Interfaces:

Cache
```
public class CacheEhCacheImpl
extends Object
implements Cache
```
EhCache implementation.
Ehcache is an open source, standards-based cache used to boost performance, offload the database and simplify scalability. Ehcache is robust, proven and full-featured and this has made it the most widely-used Java-based cache.
See https://www.ehcache.org/ expiration is specified in seconds Heavily inspired by excellent Play! 1.2.5 implementation.

Constructor Summary

Constructors
Constructor Description

CacheEhCacheImpl(org.slf4j.Logger logger)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(String key, Object value, int expiration)`	Add object to cache.
`void`	`clear()`	Clear all values in cache.
`long`	`decr(String key, int by)`	Decrements key by value.
`void`	`delete(String key)`	Delete key from cache.
`Object`	`get(String key)`	Returns the object for this key or null if not found.
`Map<String,Object>`	`get(String[] keys)`	Returns all objects for the keys.
`long`	`incr(String key, int by)`	Increments key by value.
`void`	`replace(String key, Object value, int expiration)`	Replaces key with new value.
`boolean`	`safeAdd(String key, Object value, int expiration)`	Similar to `delete` method.
`boolean`	`safeDelete(String key)`	Similar to `delete` method.
`boolean`	`safeReplace(String key, Object value, int expiration)`	Similar to `delete` method.
`boolean`	`safeSet(String key, Object value, int expiration)`	Similar to `delete` method.
`void`	`set(String key, Object value, int expiration)`	Adds object of cache.
`void`	`stop()`

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

- Constructor Detail
  - CacheEhCacheImpl
```
@Inject
public CacheEhCacheImpl(org.slf4j.Logger logger)
```
- Method Detail
  - add
```
public void add(String key,
                Object value,
                int expiration)
```
    Description copied from interface: Cache
    
    Add object to cache. Important: If the key exists already it won't be overwritten. Use set(...) instead. This method is fire and forget. Implementations may implement this async and non-blocking.
    
    Specified by:
    
    add in interface Cache
    
    Parameters:
    
    key - The key of the object to use for caching.
    
    value - The value of the object to add to the cache.
    
    expiration - Expiration time in seconds.
  - clear
```
public void clear()
```
    Description copied from interface: Cache
    
    Clear all values in cache.
    
    Specified by:
    
    clear in interface Cache
  - decr
```
public long decr(String key,
                 int by)
```
    Description copied from interface: Cache
    
    Decrements key by value.
    
    Specified by:
    
    decr in interface Cache
    
    Parameters:
    
    key - The key to decrement
    
    by - Value by which to decrement.
    
    Returns:
    
    New value of the key or -1 if key does not exist.
  - delete
```
public void delete(String key)
```
    Description copied from interface: Cache
    
    Delete key from cache.
    
    Specified by:
    
    delete in interface Cache
    
    Parameters:
    
    key - The key to delete.
  - get
```
public Object get(String key)
```
    Description copied from interface: Cache
    
    Returns the object for this key or null if not found.
    
    Specified by:
    
    get in interface Cache
    
    Parameters:
    
    key - The key of the object to retrieve.
    
    Returns:
    
    The object of the key or null if not found.
  - get
```
public Map<String,Object> get(String[] keys)
```
    Description copied from interface: Cache
    
    Returns all objects for the keys.
    
    Specified by:
    
    get in interface Cache
    
    Parameters:
    
    keys - The list of keys to retrieve from Cache.
    
    Returns:
    
    A map with key - object pairs that were found in cache.
  - incr
```
public long incr(String key,
                 int by)
```
    Description copied from interface: Cache
    
    Increments key by value.
    
    Specified by:
    
    incr in interface Cache
    
    Parameters:
    
    key - The key to increment
    
    by - Value by which to increment.
    
    Returns:
    
    New value of the key or -1 if key does not exist.
  - replace
```
public void replace(String key,
                    Object value,
                    int expiration)
```
    Description copied from interface: Cache
    
    Replaces key with new value. Important: Will do nothing if the key does not exist. This method is fire and forget. Implementations may implement this async and non-blocking.
    
    Specified by:
    
    replace in interface Cache
    
    Parameters:
    
    key - The key of the object to use for caching.
    
    value - The value of the object to replace in the cache.
    
    expiration - Expiration time in seconds.
  - safeAdd
```
public boolean safeAdd(String key,
                       Object value,
                       int expiration)
```
    Description copied from interface: Cache
    
    Similar to delete method. BUT it blocks until execution succeeds / fails AND wraps exceptions in a simple true / false return value
    
    Specified by:
    
    safeAdd in interface Cache
    
    Parameters:
    
    key - The key of the object to use for caching.
    
    value - The value of the object to add in the cache.
    
    expiration - Expiration time in seconds.
    
    Returns:
    
    true if add was successful, false if not.
  - safeDelete
```
public boolean safeDelete(String key)
```
    Description copied from interface: Cache
    
    Similar to delete method. BUT it blocks until execution succeeds / fails AND wraps exceptions in a simple true / false return value
    
    Specified by:
    
    safeDelete in interface Cache
    
    Parameters:
    
    key - The key to delete
    
    Returns:
    
    true if deletion was successful, false if not.
  - safeReplace
```
public boolean safeReplace(String key,
                           Object value,
                           int expiration)
```
    Description copied from interface: Cache
    
    Similar to delete method. BUT it blocks until execution succeeds / fails AND wraps exceptions in a simple true / false return value
    
    Specified by:
    
    safeReplace in interface Cache
    
    Parameters:
    
    key - The key of the object to use for caching.
    
    value - The value of the object to replace in the cache.
    
    expiration - Expiration time in seconds.
    
    Returns:
    
    true if replace was successful, false if not.
  - safeSet
```
public boolean safeSet(String key,
                       Object value,
                       int expiration)
```
    Description copied from interface: Cache
    
    Similar to delete method. BUT it blocks until execution succeeds / fails AND wraps exceptions in a simple true / false return value
    
    Specified by:
    
    safeSet in interface Cache
    
    Parameters:
    
    key - The key of the object to use for caching.
    
    value - The value of the object to set in the cache.
    
    expiration - Expiration time in seconds.
    
    Returns:
    
    true if set was successful, false if not.
  - set
```
public void set(String key,
                Object value,
                int expiration)
```
    Description copied from interface: Cache
    
    Adds object of cache. Important: This method potentially overwrites previously existing object with new values. This method is fire and forget. Implementations may implement this async and non-blocking.
    
    Specified by:
    
    set in interface Cache
    
    Parameters:
    
    key - The key of the object to use for caching.
    
    value - The value of the object to set in the cache.
    
    expiration - Expiration time in seconds.
  - stop
```
public void stop()
```

Class CacheEhCacheImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheEhCacheImpl

Method Detail

add

clear

decr

delete

get

get

incr

replace

safeAdd

safeDelete

safeReplace

safeSet

set

stop