AbstractCache (Jedis 7.0.0 API)

java.lang.Object
- redis.clients.jedis.csc.AbstractCache

All Implemented Interfaces:

Cache

Direct Known Subclasses:

DefaultCache
```
@Experimental
public abstract class AbstractCache
extends java.lang.Object
implements Cache
```
The class to manage the client-side caching. User can provide an of implementation of this class to the client object.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractCache(int maximumSize)

protected AbstractCache(int maximumSize, Cacheable cacheable)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCache(int maximumSize)`
`protected`	`AbstractCache(int maximumSize, Cacheable cacheable)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`clearStore()`
`boolean`	`compatibilityMode()`
`protected abstract boolean`	`containsKeyInStore(CacheKey cacheKey)`
`boolean`	`delete(CacheKey cacheKey)` Delete an entry by cache key
`java.util.List<java.lang.Boolean>`	`delete(java.util.List<CacheKey> cacheKeys)` Delete entries by cache key from the cache
`java.util.List<CacheKey>`	`deleteByRedisKey(java.lang.Object key)` Delete an entry by the Redis key from the cache
`java.util.List<CacheKey>`	`deleteByRedisKeys(java.util.List keys)` Delete entries by the Redis key from the cache
`int`	`flush()` Flushes the entire cache
`CacheEntry`	`get(CacheKey cacheKey)` Fetches a value from the cache
`CacheStats`	`getAndResetStats()`
`abstract java.util.Collection<CacheEntry>`	`getCacheEntries()`
`abstract EvictionPolicy`	`getEvictionPolicy()`
`protected abstract CacheEntry`	`getFromStore(CacheKey cacheKey)`
`int`	`getMaxSize()`
`abstract int`	`getSize()`
`CacheStats`	`getStats()`
`boolean`	`hasCacheKey(CacheKey cacheKey)`
`boolean`	`isCacheable(CacheKey cacheKey)`
`protected abstract CacheEntry`	`putIntoStore(CacheKey cacheKey, CacheEntry entry)`
`protected abstract boolean`	`removeFromStore(CacheKey cacheKey)`
`CacheEntry`	`set(CacheKey cacheKey, CacheEntry entry)` Puts a value into the cache

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

- Constructor Detail
  - AbstractCache
```
protected AbstractCache(int maximumSize)
```
  - AbstractCache
```
protected AbstractCache(int maximumSize,
                        Cacheable cacheable)
```
- Method Detail
  - getMaxSize
```
public int getMaxSize()
```
    Specified by:
    
    getMaxSize in interface Cache
    
    Returns:
    
    The size of the cache
  - getSize
```
public abstract int getSize()
```
    Specified by:
    
    getSize in interface Cache
    
    Returns:
    
    The current size of the cache
  - getCacheEntries
```
public abstract java.util.Collection<CacheEntry> getCacheEntries()
```
    Specified by:
    
    getCacheEntries in interface Cache
    
    Returns:
    
    All the entries within the cache
  - get
```
public CacheEntry get(CacheKey cacheKey)
```
    Description copied from interface: Cache
    
    Fetches a value from the cache
    
    Specified by:
    
    get in interface Cache
    
    Parameters:
    
    cacheKey - The key within the cache
    
    Returns:
    
    The entry within the cache
  - set
```
public CacheEntry set(CacheKey cacheKey,
                      CacheEntry entry)
```
    Description copied from interface: Cache
    
    Puts a value into the cache
    
    Specified by:
    
    set in interface Cache
    
    Parameters:
    
    cacheKey - The key by which the value can be accessed within the cache
    
    entry - The value to be put into the cache
    
    Returns:
    
    The cache entry
  - delete
```
public boolean delete(CacheKey cacheKey)
```
    Description copied from interface: Cache
    
    Delete an entry by cache key
    
    Specified by:
    
    delete in interface Cache
    
    Parameters:
    
    cacheKey - The cache key of the entry in the cache
    
    Returns:
    
    True if the entry could be deleted, false if the entry wasn't found.
  - delete
```
public java.util.List<java.lang.Boolean> delete(java.util.List<CacheKey> cacheKeys)
```
    Description copied from interface: Cache
    
    Delete entries by cache key from the cache
    
    Specified by:
    
    delete in interface Cache
    
    Parameters:
    
    cacheKeys - The cache keys of the entries that should be deleted
    
    Returns:
    
    True for every entry that could be deleted. False if the entry was not there.
  - deleteByRedisKey
```
public java.util.List<CacheKey> deleteByRedisKey(java.lang.Object key)
```
    Description copied from interface: Cache
    
    Delete an entry by the Redis key from the cache
    
    Specified by:
    
    deleteByRedisKey in interface Cache
    
    Parameters:
    
    key - The Redis key as binary
    
    Returns:
    
    True if the entry could be deleted. False if the entry was not there.
  - deleteByRedisKeys
```
public java.util.List<CacheKey> deleteByRedisKeys(java.util.List keys)
```
    Description copied from interface: Cache
    
    Delete entries by the Redis key from the cache
    
    Specified by:
    
    deleteByRedisKeys in interface Cache
    
    Parameters:
    
    keys - The Redis keys as binaries
    
    Returns:
    
    True for every entry that could be deleted. False if the entry was not there.
  - flush
```
public int flush()
```
    Description copied from interface: Cache
    
    Flushes the entire cache
    
    Specified by:
    
    flush in interface Cache
    
    Returns:
    
    Return the number of entries that were flushed
  - isCacheable
```
public boolean isCacheable(CacheKey cacheKey)
```
    Specified by:
    
    isCacheable in interface Cache
    
    Parameters:
    
    cacheKey - The key of the cache entry
    
    Returns:
    
    True if the entry is cachable, false otherwise
  - hasCacheKey
```
public boolean hasCacheKey(CacheKey cacheKey)
```
    Specified by:
    
    hasCacheKey in interface Cache
    
    Parameters:
    
    cacheKey - The key of the cache entry
    
    Returns:
    
    True if the cache already contains the key
  - getEvictionPolicy
```
public abstract EvictionPolicy getEvictionPolicy()
```
    Specified by:
    
    getEvictionPolicy in interface Cache
    
    Returns:
    
    The eviction policy that is used by the cache
  - getStats
```
public CacheStats getStats()
```
    Specified by:
    
    getStats in interface Cache
    
    Returns:
    
    The statistics of the cache
  - getAndResetStats
```
public CacheStats getAndResetStats()
```
    Specified by:
    
    getAndResetStats in interface Cache
    
    Returns:
    
    The statistics of the cache
  - compatibilityMode
```
public boolean compatibilityMode()
```
    Specified by:
    
    compatibilityMode in interface Cache
    
    Returns:
    
    The compatibility of cache against different Redis versions
  - getFromStore
```
protected abstract CacheEntry getFromStore(CacheKey cacheKey)
```
  - putIntoStore
```
protected abstract CacheEntry putIntoStore(CacheKey cacheKey,
                                           CacheEntry entry)
```
  - removeFromStore
```
protected abstract boolean removeFromStore(CacheKey cacheKey)
```
  - clearStore
```
protected abstract void clearStore()
```
  - containsKeyInStore
```
protected abstract boolean containsKeyInStore(CacheKey cacheKey)
```

Class AbstractCache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCache

AbstractCache

Method Detail

getMaxSize

getSize

getCacheEntries

get

set

delete

delete

deleteByRedisKey

deleteByRedisKeys

flush

isCacheable

hasCacheKey

getEvictionPolicy

getStats

getAndResetStats

compatibilityMode

getFromStore

putIntoStore

removeFromStore

clearStore

containsKeyInStore