java.lang.Object
- org.cyclos.impl.utils.cache.CacheHandlerImpl

All Implemented Interfaces:

CacheHandler, CacheHandlerImplementor

Direct Known Subclasses:

GuavaCacheHandlerImpl
```
public abstract class CacheHandlerImpl
extends Object
implements CacheHandlerImplementor
```
A CacheHandler implementation which configures Guava caches

Field Summary

Fields
Modifier and Type Field Description

static String LOCAL_CACHE

Constructor Summary

Constructors
Constructor Description

CacheHandlerImpl()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`apply(TreeMap<CacheType<? extends Serializable,? extends Serializable>,CacheOperation> operations)`	Apply the given cache operations for each `CacheType`.
`protected <V,K> com.google.common.cache.Cache<K,V>`	`createGuavaCache(String name)`
`void`	`destroy()`
`<K extends Serializable,V extends Serializable> Cache<K,V>`	`getCache(CacheType<K,V> type)`	Returns the `Cache` implementation for the given type
`<K extends Serializable,V extends Serializable> Cache<K,V>`	`getCacheIfInitialized(CacheType<K,V> type)`	Returns the `Cache` implementation for the given type if it has already been initialized, or null otherwise
`com.google.common.cache.Cache<Object,Object>`	`getLocalCache()`	The local cache is a general-purpose Guava cache that can be used to store data in a cluster will never be distributed
`protected abstract <K extends Serializable,V extends Serializable> Cache<K,V>`	`initCache(CacheType<K,V> type)`
`void`	`initialize()`
`boolean`	`isSkipCache()`	Returns whether this cache handler is temporarily skipping caches
`<K extends Serializable,V extends Serializable> void`	`scheduleClear(CacheType<K,V> type)`	Schedules a cache clear to be executed after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
`<K extends Serializable,V extends Serializable> void`	`scheduleEvict(CacheType<K,V> type, Set<K> keys)`	Schedules the eviction of the given cache keys after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
`<K extends Serializable,V extends Serializable> void`	`scheduleEvict(CacheType<K,V> type, K key)`	Schedules the eviction of an specific cache key after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
`<K extends Serializable,V extends Serializable> void`	`schedulePartialEvict(CacheType<K,V> type, SerializablePredicate<K> predicate)`	Schedules the eviction of the keys matching the given predicate after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
`void`	`setSkipCache(boolean skipCache)`	Sets this cache handler to temporarily skip any cache (true) or to use caches normally (false)

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

- Field Detail
  - LOCAL_CACHE
```
public static final String LOCAL_CACHE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CacheHandlerImpl
```
public CacheHandlerImpl()
```
- Method Detail
  - apply
```
public void apply(TreeMap<CacheType<? extends Serializable,? extends Serializable>,CacheOperation> operations)
```
    Description copied from interface: CacheHandler
    
    Apply the given cache operations for each CacheType.
    
    Specified by:
    
    apply in interface CacheHandler
  - destroy
```
@PreDestroy
public void destroy()
```
  - getCache
```
public <K extends Serializable,V extends Serializable> Cache<K,V> getCache(CacheType<K,V> type)
```
    Description copied from interface: CacheHandler
    
    Returns the Cache implementation for the given type
    
    Specified by:
    
    getCache in interface CacheHandler
  - getCacheIfInitialized
```
public <K extends Serializable,V extends Serializable> Cache<K,V> getCacheIfInitialized(CacheType<K,V> type)
```
    Description copied from interface: CacheHandler
    
    Returns the Cache implementation for the given type if it has already been initialized, or null otherwise
    
    Specified by:
    
    getCacheIfInitialized in interface CacheHandler
  - getLocalCache
```
public com.google.common.cache.Cache<Object,Object> getLocalCache()
```
    Description copied from interface: CacheHandler
    
    The local cache is a general-purpose Guava cache that can be used to store data in a cluster will never be distributed
    
    Specified by:
    
    getLocalCache in interface CacheHandler
  - initialize
```
@PostConstruct
public void initialize()
```
  - isSkipCache
```
public boolean isSkipCache()
```
    Description copied from interface: CacheHandlerImplementor
    
    Returns whether this cache handler is temporarily skipping caches
    
    Specified by:
    
    isSkipCache in interface CacheHandlerImplementor
  - scheduleClear
```
public <K extends Serializable,V extends Serializable> void scheduleClear(CacheType<K,V> type)
```
    Description copied from interface: CacheHandler
    
    Schedules a cache clear to be executed after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
    
    Specified by:
    
    scheduleClear in interface CacheHandler
  - scheduleEvict
```
public <K extends Serializable,V extends Serializable> void scheduleEvict(CacheType<K,V> type,
                                                                                K key)
```
    Description copied from interface: CacheHandler
    
    Schedules the eviction of an specific cache key after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
    
    Specified by:
    
    scheduleEvict in interface CacheHandler
  - scheduleEvict
```
public <K extends Serializable,V extends Serializable> void scheduleEvict(CacheType<K,V> type,
                                                                                Set<K> keys)
```
    Description copied from interface: CacheHandler
    
    Schedules the eviction of the given cache keys after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
    
    Specified by:
    
    scheduleEvict in interface CacheHandler
  - schedulePartialEvict
```
public <K extends Serializable,V extends Serializable> void schedulePartialEvict(CacheType<K,V> type,
                                                                                       SerializablePredicate<K> predicate)
```
    Description copied from interface: CacheHandler
    
    Schedules the eviction of the keys matching the given predicate after the current transaction has been committed (important to prevent the cache from being reloaded by another thread before the current transaction is committed, populating the cache with a stale value)
    
    Specified by:
    
    schedulePartialEvict in interface CacheHandler
  - setSkipCache
```
public void setSkipCache(boolean skipCache)
```
    Description copied from interface: CacheHandlerImplementor
    
    Sets this cache handler to temporarily skip any cache (true) or to use caches normally (false)
    
    Specified by:
    
    setSkipCache in interface CacheHandlerImplementor
  - createGuavaCache
```
protected <V,K> com.google.common.cache.Cache<K,V> createGuavaCache(String name)
```
  - initCache
```
protected abstract <K extends Serializable,V extends Serializable> Cache<K,V> initCache(CacheType<K,V> type)
```

Class CacheHandlerImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCAL_CACHE

Constructor Detail

CacheHandlerImpl

Method Detail

apply

destroy

getCache

getCacheIfInitialized

getLocalCache

initialize

isSkipCache

scheduleClear

scheduleEvict

scheduleEvict

schedulePartialEvict

setSkipCache

createGuavaCache

initCache