bsh.util

Class ValueReferenceMap<K,V>

java.lang.Object

bsh.util.ValueReferenceMap<K,V>

public class ValueReferenceMap<K,V>
extends java.lang.Object

Implement a simple cache that automatically removes unused entries once their key or their value is no longer otherwise reachable. References can be weak or soft; both the key and the value are held at the same strength.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValueReferenceMap.Type

Constructor Summary

Constructors

Constructor and Description
ValueReferenceMap(java.util.function.Function<K,V> creator, ValueReferenceMap.Type type)

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all entries from the map
V	get(K key) Get the value for a given key.
boolean	remove(K key) Remove an entry from the map
int	size() Get map size

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueReferenceMap

public ValueReferenceMap(java.util.function.Function<K,V> creator,
                         ValueReferenceMap.Type type)

Parameters:

creator - a function that creates the value object for a given key in the map

type - the type of reference: Weak or Soft

Method Detail

get

public V get(K key)

Get the value for a given key. If the value for a given key does not exist then create one using the creator function.

Parameters:

key - the key for the required value. Must not be null.

remove

public boolean remove(K key)

Remove an entry from the map

Parameters:

key - the key for the entry

clear

public void clear()

Remove all entries from the map

size

public int size()

Get map size