NoCache (Jodd API Documentation)

java.lang.Object
- jodd.cache.NoCache<K,V>

All Implemented Interfaces:

Cache<K,V>
```
public class NoCache<K,V>
extends java.lang.Object
implements Cache<K,V>
```
Simple no-cache implementations of Cache for situation when cache needs to be quickly turned-off.

Constructor Summary

Constructors
Constructor and Description

NoCache()

Constructors
Constructor and Description
`NoCache()`

Method Summary

All Methods Instance Methods Concrete 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.
`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.

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

Methods inherited from interface jodd.cache.Cache
snapshot

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

Class NoCache<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface jodd.cache.Cache

Constructor Detail

NoCache

Method Detail

limit

timeout

put

put

get

prune

isFull

remove

clear

size

isEmpty

snapshot