Package org.faktorips.runtime.caching

Class Memoizer<K,V>

java.lang.Object

org.faktorips.runtime.caching.Memoizer<K,V>

All Implemented Interfaces:

IComputable<K,V>

public class Memoizer<K,V>
extends java.lang.Object
implements IComputable<K,V>

This Memoizer is implemented as suggested by Brian Goetz in Java Concurrency in Practice. It is a thread safe caching mechanism that loads not stored object by calling a IComputable. It is extended by the soft reference mechanism so references could be garbage collected in case of memory needs.

Author:

dirmeier

Constructor Summary

Constructors

Constructor	Description
Memoizer(IComputable<K,V> computable)	The constructor to create a Memoizer with default values for the internal ConcurrentHashMap
Memoizer(IComputable<K,V> computable, int initSize, float loadFactor, int concurrencyLevel)	This constructor needs next to the IComputable also the initial size, the load factor and the concurrency level.

Method Summary

Modifier and Type	Method	Description
V	compute(K key)	Compute an object of type V identified by the key of type K
java.lang.Class<? super V>	getValueClass()	Getting the Class of the value this computable produces.
static java.lang.RuntimeException	launderThrowable(java.lang.Throwable t)	Coerce an unchecked Throwable to a RuntimeException
static <K,V> Memoizer<K,V>	of(java.lang.Class<? super V> valueClass, java.util.function.Function<K,V> function)	Creates a new Memoizer for the given value class using the given Function to compute the values from keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

Memoizer

public Memoizer(IComputable<K,V> computable)

The constructor to create a Memoizer with default values for the internal ConcurrentHashMap

Parameters:

computable - the IComputable to load new items

See Also:

the static factory method to avoid creating the and instead using a .

Memoizer

public Memoizer(IComputable<K,V> computable,
                int initSize,
                float loadFactor,
                int concurrencyLevel)

This constructor needs next to the IComputable also the initial size, the load factor and the concurrency level. These parameters are only for tuning purpose and are directly forwarded to the internal ConcurrentHashMap.

Parameters:

computable - The IComputable to load new items

initSize - the initial size @see ConcurrentHashMap

loadFactor - the load factor @see ConcurrentHashMap

concurrencyLevel - the concurrency level @see ConcurrentHashMap

Method Detail

of

public static <K,V> Memoizer<K,V> of(java.lang.Class<? super V> valueClass,
                                                 java.util.function.Function<K,V> function)

Creates a new Memoizer for the given value class using the given Function to compute the values from keys.

Type Parameters:

K - the key type

V - the value type

Parameters:

valueClass - the class of the values

function - the function to compute a value from a key

Returns:

a new IComputable

compute

public V compute(K key)
          throws java.lang.InterruptedException

Description copied from interface: IComputable

Compute an object of type V identified by the key of type K

Specified by:

compute in interface IComputable<K,V>

Parameters:

key - the key to identify the object

Returns:

the computed Object of type V

Throws:

java.lang.InterruptedException - When computation was interrupted

launderThrowable

public static java.lang.RuntimeException launderThrowable(java.lang.Throwable t)

Coerce an unchecked Throwable to a RuntimeException

If the Throwable is an Error, throw it; if it is a RuntimeException return it, otherwise throw IllegalStateException

getValueClass

public java.lang.Class<? super V> getValueClass()

Description copied from interface: IComputable

Getting the Class of the value this computable produces.

Specified by:

getValueClass in interface IComputable<K,V>