com.github.dandelion.core.cache

Interface Cache<K,V>

All Known Implementing Classes:

StandardCache

public interface Cache<K,V>

Since:

1.0.0

Author:

Thibault Duchateau

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the entire cache.
void	clearKey(K key) Clears a specific entry in the cache.
V	get(K key) Retrieve a value from the cache.
Set<K>	keySet() Returns all the keys contained in this cache.
void	put(K key, V value) Insert a new value into the cache.
int	size()

Method Detail

put

void put(K key,
       V value)

Insert a new value into the cache.

Parameters:

key - the key of the new entry.

value - the value to be cached.

get

V get(K key)

Retrieve a value from the cache.

Parameters:

key - the key of the value to be retrieved.

Returns:

the retrieved value, or null if no value exists for the specified key.

clear

void clear()

Clear the entire cache.

clearKey

void clearKey(K key)

Clears a specific entry in the cache.

Parameters:

key - the key of the entry to be cleared.

keySet

Set<K> keySet()

Returns all the keys contained in this cache.

Returns:

the complete set of cache keys.

size

int size()

Returns:

the number of cached entries.