org.tinymediamanager.scraper.util

Class CacheMap<K,T>

java.lang.Object

org.tinymediamanager.scraper.util.CacheMap<K,T>

Type Parameters:

K - the key of the map

T - the value

public class CacheMap<K,T>
extends Object

The class CacheMap is used to cache certain key/value pairs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CacheMap.CacheObject inner class for managing the cache entries

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<K,CacheMap.CacheObject>	cacheMap
protected ReadWriteLock	readWriteLock
protected long	timeToLive

Constructor Summary

Constructors

Constructor and Description
CacheMap(long timeToLive, long cleanupInterval) Constructs a new CacheMap

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Cleanup the map checking the time to live for each entry
void	cleanup(boolean force) Cleanup the map checking the time to live for each entry or force cleaning
T	get(K key) Get the specified object from the map (or null if no object is found)
void	put(K key, T value) Put a new object to the map
void	remove(K key) Removes the specified object from the map
int	size() Get the actual size of the map

Methods inherited from class java.lang.Object

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

Field Detail

timeToLive

protected long timeToLive

cacheMap

protected Map<K,CacheMap.CacheObject> cacheMap

readWriteLock

protected ReadWriteLock readWriteLock

Constructor Detail

CacheMap

public CacheMap(long timeToLive,
        long cleanupInterval)

Constructs a new CacheMap

Parameters:

timeToLive - time to live in the map (in seconds)

cleanupInterval - cache cleaning interval (in seconds)

Method Detail

put

public void put(K key,
       T value)

Put a new object to the map

Parameters:

key - the key of the entry

value - the value of the entry

get

public T get(K key)

Get the specified object from the map (or null if no object is found)

Parameters:

key - the key of the entry to get

Returns:

the entry (if found) or null

remove

public void remove(K key)

Removes the specified object from the map

Parameters:

key - the key of the entry

size

public int size()

Get the actual size of the map

Returns:

the actual size of the map

cleanup

public void cleanup()

Cleanup the map checking the time to live for each entry

cleanup

public void cleanup(boolean force)

Cleanup the map checking the time to live for each entry or force cleaning

Parameters:

force - force cleanup