uk.gov.gchq.gaffer.cache

Class AbstractCacheService

java.lang.Object

uk.gov.gchq.gaffer.cache.AbstractCacheService

All Implemented Interfaces:

ICacheService

public abstract class AbstractCacheService
extends Object
implements ICacheService

An abstract service which handles all the cache interaction methods. This leaves only the getCache() method which will be fulfilled according to the cache implementation.

Constructor Summary

Constructors

Constructor and Description
AbstractCacheService()

Method Summary

Modifier and Type	Method and Description
void	clearCache(String cacheName) Clear the contents of the specified cache.
<K,V> Set<K>	getAllKeysFromCache(String cacheName) Get all of the keys associated with the specified cache.
<K,V> Collection<V>	getAllValuesFromCache(String cacheName) Get all of the values associated with the specified cache.
abstract <K,V> ICache<K,V>	getCache(String cacheName) Get the named cache from the cache service.
<K,V> V	getFromCache(String cacheName, K key) Get the value associated with the specified cache and key.
<K,V> void	putInCache(String cacheName, K key, V value) Add a new key-value pair to the specified cache.
<K,V> void	putSafeInCache(String cacheName, K key, V value) Add a new key-value pair to the specified cache, but only if there is no existing entry associated with the specified key.
<K,V> void	removeFromCache(String cacheName, K key) Remove the entry associated with the specified key from the specified cache.
int	sizeOfCache(String cacheName) Retrieve the size of the specified cache.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.cache.ICacheService

initialise, shutdown

Constructor Detail

AbstractCacheService

public AbstractCacheService()

Method Detail

getCache

public abstract <K,V> ICache<K,V> getCache(String cacheName)

Description copied from interface: ICacheService

Get the named cache from the cache service.

Specified by:

getCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache to retrieve

Returns:

the requested cache object

getFromCache

public <K,V> V getFromCache(String cacheName,
                            K key)

Description copied from interface: ICacheService

Get the value associated with the specified cache and key.

Specified by:

getFromCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache to look in

key - the key of the entry to lookup

Returns:

the requested cache object

putInCache

public <K,V> void putInCache(String cacheName,
                             K key,
                             V value)
                      throws CacheOperationException

Description copied from interface: ICacheService

Add a new key-value pair to the specified cache.

Specified by:

putInCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache

key - the key to add

value - the value to add

Throws:

CacheOperationException - if there is an error adding the new key-value pair to the cache

putSafeInCache

public <K,V> void putSafeInCache(String cacheName,
                                 K key,
                                 V value)
                          throws CacheOperationException

Description copied from interface: ICacheService

Add a new key-value pair to the specified cache, but only if there is no existing entry associated with the specified key.

Specified by:

putSafeInCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache

key - the key to add

value - the value to add

Throws:

CacheOperationException - if the specified key already exists in the cache with a non-null value

removeFromCache

public <K,V> void removeFromCache(String cacheName,
                                  K key)

Description copied from interface: ICacheService

Remove the entry associated with the specified key from the specified cache.

Specified by:

removeFromCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache to look in

key - the key of the entry to remove

getAllValuesFromCache

public <K,V> Collection<V> getAllValuesFromCache(String cacheName)

Description copied from interface: ICacheService

Get all of the values associated with the specified cache.

Specified by:

getAllValuesFromCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache to look in

Returns:

the requested cache objects

getAllKeysFromCache

public <K,V> Set<K> getAllKeysFromCache(String cacheName)

Description copied from interface: ICacheService

Get all of the keys associated with the specified cache.

Specified by:

getAllKeysFromCache in interface ICacheService

Type Parameters:

K - The object type that acts as the key for the cache

V - The value that is stored in the cache

Parameters:

cacheName - the name of the cache to look in

Returns:

the requested cache keys

sizeOfCache

public int sizeOfCache(String cacheName)

Description copied from interface: ICacheService

Retrieve the size of the specified cache.

Specified by:

sizeOfCache in interface ICacheService

Parameters:

cacheName - the name of the cache

Returns:

the size of the cache

clearCache

public void clearCache(String cacheName)
                throws CacheOperationException

Description copied from interface: ICacheService

Clear the contents of the specified cache.

Specified by:

clearCache in interface ICacheService

Parameters:

cacheName - the name of the cache to clear

Throws:

CacheOperationException - if there was an error clearing the cache