net.sf.jkniv.cache

Interface Cacheable<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - Type of objects stored in cache

All Known Implementing Classes:

MemoryCache, NoCache

public interface Cacheable<K,V>

An object that maps keys to values. A map cannot contain duplicate keys; each key can map to at most one value.

Since:

0.6.0

Author:

Alisson Gomes

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Cacheable.Entry<V> A cache entry (key-value pair).

Method Summary

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 value) 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.

Method Detail

getName

String getName()

cache name

Returns:

the cache name

getPolicy

CachePolicy getPolicy()

policy that maintenance the capacity and expire time of data

Returns:

rules to cache maintain the data

setPolicy

void setPolicy(CachePolicy policy)

Policy to control the cache data

Parameters:

policy - that maintenance the capacity and expire time of data

put

V put(K key,
      V value)

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.

Parameters:

key - with which the specified value is to be associated

value - to be associated with the specified key

Returns:

the previous value associated with key, or null if there isn't mapping for key.

Throws:

IllegalArgumentException - if some the key or value are null.

get

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.

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

Cacheable.Entry<V> getEntry(K key)

Returns a Cacheable.Entry view of the mappings contained in this cache.

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

Set<Map.Entry<K,Cacheable.Entry<V>>> entrySet()

remove

Cacheable.Entry<V> remove(K key)

clear

void clear()

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

size

long size()

Returns the number of key-value mappings in this map. If the cache contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

the number of elements in this cache