MemoryCache (jkniv 0.6.6 API)

java.lang.Object
- net.sf.jkniv.cache.MemoryCache<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - Type of objects stored in cache

All Implemented Interfaces:

Cacheable<K,V>
```
public class MemoryCache<K,V>
extends Object
implements Cacheable<K,V>
```
MemoryCache based implementation of the Cacheable interface. This implementation provides a memory cache to keep the objects mapped keys to values. The Cacheable doesn't permit null values. Default policy parameters:
- Time-to-Live (TTL) default value is 10 minutes
- Time-to-idle (TTI) default value is forever
- Cache size default value is 1000 elements
Since:

0.6.0

Author:

Alisson Gomes

Constructor Summary

Constructors
Constructor and Description

MemoryCache()

MemoryCache(CachePolicy policy)

MemoryCache(CachePolicy policy, String name)

MemoryCache(String name)

Constructors
Constructor and Description
`MemoryCache()`
`MemoryCache(CachePolicy policy)`
`MemoryCache(CachePolicy policy, String name)`
`MemoryCache(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all of the mappings from this map (optional operation).
`Set<Map.Entry<K,Cacheable.Entry<V>>>`	`entrySet()`
`V`	`get(K key)` Returns the value to which the specified key is cached, or `null` if this cache contains no mapping for the key.
`Cacheable.Entry<V>`	`getEntry(K key)` Returns a `Cacheable.Entry` view of the mappings contained in this cache.
`String`	`getName()` cache name
`CachePolicy`	`getPolicy()` policy that maintenance the capacity and expire time of data
`V`	`put(K key, V object)` Associates the specified value with the specified key in this cache If the cache previously contained a mapping for the key, the old value is replaced by the specified value.
`Cacheable.Entry<V>`	`remove(K key)`
`void`	`setPolicy(CachePolicy policy)` Policy to control the cache data
`long`	`size()` Returns the number of key-value mappings in this map.
`String`	`toString()`

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

- Constructor Detail
  - MemoryCache
```
public MemoryCache()
```
  - MemoryCache
```
public MemoryCache(String name)
```
  - MemoryCache
```
public MemoryCache(CachePolicy policy)
```
  - MemoryCache
```
public MemoryCache(CachePolicy policy,
                   String name)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Cacheable
    
    cache name
    
    Specified by:
    
    getName in interface Cacheable<K,V>
    
    Returns:
    
    the cache name
  - getPolicy
```
public CachePolicy getPolicy()
```
    Description copied from interface: Cacheable
    
    policy that maintenance the capacity and expire time of data
    
    Specified by:
    
    getPolicy in interface Cacheable<K,V>
    
    Returns:
    
    rules to cache maintain the data
  - setPolicy
```
public void setPolicy(CachePolicy policy)
```
    Description copied from interface: Cacheable
    
    Policy to control the cache data
    
    Specified by:
    
    setPolicy in interface Cacheable<K,V>
    
    Parameters:
    
    policy - that maintenance the capacity and expire time of data
  - put
```
public V put(K key,
             V object)
```
    Description copied from interface: Cacheable
    
    Associates the specified value with the specified key in this cache If the cache previously contained a mapping for the key, the old value is replaced by the specified value.
    
    Specified by:
    
    put in interface Cacheable<K,V>
    
    Parameters:
    
    key - with which the specified value is to be associated
    
    object - to be associated with the specified key
    
    Returns:
    
    the previous value associated with key, or null if there isn't mapping for key.
  - get
```
public V get(K key)
```
    Description copied from interface: Cacheable
    
    Returns the value to which the specified key is cached, or null if this cache contains no mapping for the key.
    
    Specified by:
    
    get in interface Cacheable<K,V>
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is cached, or null if this map contains no mapping for the key
  - getEntry
```
public Cacheable.Entry<V> getEntry(K key)
```
    Description copied from interface: Cacheable
    
    Returns a Cacheable.Entry view of the mappings contained in this cache.
    
    Specified by:
    
    getEntry in interface Cacheable<K,V>
    
    Parameters:
    
    key - the key whose associated with entry is to be returned
    
    Returns:
    
    a set view of the Cacheable.Entry contained in this cache, or null if this map contains no mapping for the key
  - entrySet
```
public Set<Map.Entry<K,Cacheable.Entry<V>>> entrySet()
```
    Specified by:
    
    entrySet in interface Cacheable<K,V>
  - remove
```
public Cacheable.Entry<V> remove(K key)
```
    Specified by:
    
    remove in interface Cacheable<K,V>
  - clear
```
public void clear()
```
    Description copied from interface: Cacheable
    
    Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
    
    Specified by:
    
    clear in interface Cacheable<K,V>
  - size
```
public long size()
```
    Description copied from interface: Cacheable
    
    Returns the number of key-value mappings in this map. If the cache contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
    
    Specified by:
    
    size in interface Cacheable<K,V>
    
    Returns:
    
    the number of elements in this cache
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MemoryCache<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MemoryCache

MemoryCache

MemoryCache

MemoryCache

Method Detail

getName

getPolicy

setPolicy

put

get

getEntry

entrySet

remove

clear

size

toString