net.lecousin.framework.memory

Class Cache<Key,Value>

java.lang.Object

net.lecousin.framework.memory.Cache<Key,Value>

Type Parameters:

Key - type of key

Value - type of cached data

All Implemented Interfaces:

CacheManager, IMemoryManageable

public class Cache<Key,Value>
extends Object
implements CacheManager

Implementation of CacheManager that associate each cached data to a key.

Nested Class Summary

Nested classes/interfaces inherited from interface net.lecousin.framework.memory.CacheManager

CacheManager.CachedData, CacheManager.CachedDataCustomExpiration

Nested classes/interfaces inherited from interface net.lecousin.framework.memory.IMemoryManageable

IMemoryManageable.FreeMemoryLevel

Constructor Summary

Constructors

Constructor and Description
Cache(String description, Consumer<Value> freer) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close this cache, and free any data it holds.
boolean	free(CacheManager.CachedData data) Free the given data.
void	free(Value value, CloseableListenable user) Signal that the given cached data is not anymore used by the given user.
Value	get(Key key, CloseableListenable user) Return the cached data corresponding to the given key, or null if it does not exist.
Collection<? extends CacheManager.CachedData>	getCachedData() Return this list of cached data.
String	getDescription() Desciption.
List<String>	getItemsDescription() Describe each item that can be freed.
void	put(Key key, Value value, CloseableListenable firstUser) Add the given data to this cache, and add the given first user to it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.lecousin.framework.memory.CacheManager

freeMemory, getCachedDataExpiration, getDefaultCachedDataExpiration

Constructor Detail

Cache

public Cache(String description,
             Consumer<Value> freer)

Constructor.

Method Detail

get

public Value get(Key key,
                 CloseableListenable user)

Return the cached data corresponding to the given key, or null if it does not exist. The given user is added as using the cached data. Once closed, the user is automatically removed from the list of users.

free

public void free(Value value,
                 CloseableListenable user)

Signal that the given cached data is not anymore used by the given user.

put

public void put(Key key,
                Value value,
                CloseableListenable firstUser)

Add the given data to this cache, and add the given first user to it.

getCachedData

public Collection<? extends CacheManager.CachedData> getCachedData()

Description copied from interface: CacheManager

Return this list of cached data.

Specified by:

getCachedData in interface CacheManager

free

public boolean free(CacheManager.CachedData data)

Description copied from interface: CacheManager

Free the given data.

Specified by:

free in interface CacheManager

getDescription

public String getDescription()

Description copied from interface: IMemoryManageable

Desciption.

Specified by:

getDescription in interface IMemoryManageable

getItemsDescription

public List<String> getItemsDescription()

Description copied from interface: IMemoryManageable

Describe each item that can be freed.

Specified by:

getItemsDescription in interface IMemoryManageable

close

public void close()

Close this cache, and free any data it holds.