org.apache.oodt.commons.util

Class CacheMap

java.lang.Object

org.apache.oodt.commons.util.CacheMap

All Implemented Interfaces:

Map

public class CacheMap
extends Object
implements Map

A cache map is a map with a built-in cache. It operates in all ways like a regular Map, except that you can store only a limited number of entries. After adding an entry that exceeds the size of the cache, the map ejects the least recently used entry.

Author:

Kelly

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CacheMap() Create a cache map with a default capacity of 5 entries.
CacheMap(int capacity) Create a cache map with the given capacity.
CacheMap(Map map) Create a cache map from the given map, having the capacity of the given map.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key) Returns true if there's a mapping for the specified key in the cache map.
boolean	containsValue(Object value) Returns true if there's a mapping for the specified value in the cache map.
Set	entrySet()
boolean	equals(Object rhs)
Object	get(Object key)
int	getCapacity() Get the cache map's capacity.
int	hashCode()
boolean	isEmpty()
Set	keySet()
Object	put(Object key, Object value)
void	putAll(Map t)
Object	remove(Object key)
int	size()
Collection	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CacheMap

public CacheMap()

Create a cache map with a default capacity of 5 entries.

CacheMap

public CacheMap(int capacity)

Create a cache map with the given capacity.

Parameters:

capacity - How big the cache is.

CacheMap

public CacheMap(Map map)

Create a cache map from the given map, having the capacity of the given map.

Parameters:

map - The map to copy.

Method Detail

getCapacity

public int getCapacity()

Get the cache map's capacity.

Returns:

Its capacity.

size

public int size()

Specified by:

size in interface Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map

containsKey

public boolean containsKey(Object key)

Returns true if there's a mapping for the specified key in the cache map. This method does not otherwise affect the cache.

Specified by:

containsKey in interface Map

Parameters:

key - Key to check.

Returns:

True if the cache map contains a mapping for the key.

containsValue

public boolean containsValue(Object value)

Returns true if there's a mapping for the specified value in the cache map. This method does not otherwise affect the cache.

Specified by:

containsValue in interface Map

Parameters:

value - Value to check.

Returns:

True if the cache map contains a mapping for the value.

get

public Object get(Object key)

Specified by:

get in interface Map

put

public Object put(Object key,
                  Object value)

Specified by:

put in interface Map

remove

public Object remove(Object key)

Specified by:

remove in interface Map

putAll

public void putAll(Map t)

Specified by:

putAll in interface Map

clear

public void clear()

Specified by:

clear in interface Map

keySet

public Set keySet()

Specified by:

keySet in interface Map

values

public Collection values()

Specified by:

values in interface Map

entrySet

public Set entrySet()

Specified by:

entrySet in interface Map

equals

public boolean equals(Object rhs)

Specified by:

equals in interface Map

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map

Overrides:

hashCode in class Object