Cache (Jodd API Documentation)

All Known Implementing Classes:

AbstractCacheMap, FIFOCache, LFUCache, LRUCache, NoCache, TimedCache
```
public interface Cache<K,V>
```
Cache interface.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears current cache.
`V`	`get(K key)` Retrieves an object from the cache.
`boolean`	`isEmpty()` Returns `true` if cache is empty.
`boolean`	`isFull()` Returns `true` if max cache capacity has been reached only if cache is size limited.
`int`	`limit()` Returns cache size or `0` if there is no size limit.
`int`	`prune()` Prunes objects from cache and returns the number of removed objects.
`void`	`put(K key, V object)` Adds an object to the cache with default timeout.
`void`	`put(K key, V object, long timeout)` Adds an object to the cache with specified timeout after which it becomes expired.
`V`	`remove(K key)` Removes an object from the cache and returns removed value of `null` if object was not in the cache or was expired.
`int`	`size()` Returns current cache size.
`default java.util.Map<K,V>`	`snapshot()`
`java.util.Map<K,V>`	`snapshot(boolean peek)` Creates a snapshot from current cache values.
`long`	`timeout()` Returns default timeout or `0` if it is not set.

- Method Detail
  - limit
```
int limit()
```
    Returns cache size or 0 if there is no size limit.
  - timeout
```
long timeout()
```
    Returns default timeout or 0 if it is not set.
  - put
```
void put(K key,
         V object)
```
    Adds an object to the cache with default timeout.
    
    See Also:
    
    put(Object, Object, long)
  - put
```
void put(K key,
         V object,
         long timeout)
```
    Adds an object to the cache with specified timeout after which it becomes expired. If cache is full, prune() is invoked to make room for new object. Cached value must be non-null.
  - get
```
V get(K key)
```
    Retrieves an object from the cache. Returns null if object is not longer in cache or if it is expired.
  - prune
```
int prune()
```
    Prunes objects from cache and returns the number of removed objects. Used strategy depends on cache implementation.
  - isFull
```
boolean isFull()
```
    Returns true if max cache capacity has been reached only if cache is size limited.
  - remove
```
V remove(K key)
```
    Removes an object from the cache and returns removed value of null if object was not in the cache or was expired.
  - clear
```
void clear()
```
    Clears current cache.
  - size
```
int size()
```
    Returns current cache size.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if cache is empty.
  - snapshot
```
java.util.Map<K,V> snapshot(boolean peek)
```
    Creates a snapshot from current cache values. Returned values may not longer be valid or they might be already expired! Cache is locked during the snapshot creation.
    
    Parameters:
    
    peek - if set, snapshot will just peek the object and not get them (and modify last access)
  - snapshot
```
default java.util.Map<K,V> snapshot()
```

Interface Cache<K,V>

Method Summary

Method Detail

limit

timeout

put

put

get

prune

isFull

remove

clear

size

isEmpty

snapshot

snapshot