Top Description Inners Fields Constructors Methods
org.eclipse.persistence.internal.cache

public Class Memoizer<A, V>

extends Object
implements LowLevelProcessor<A, V>
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.internal.cache.LowLevelProcessor
Imports
java.util.Map, java.util.concurrent.Callable, .CancellationException, .ConcurrentHashMap, .ConcurrentMap, .ExecutionException, .Future, .FutureTask

Memoizer for computing resource expensive tasks asynchronously & concurrently. Inspired by D. Lea. JCiP, 2nd edition. Addison-Wesley, 2006. pp.109
Author
Marcel Valovy - [email protected]
Since
2.6

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
Memoizer.KeyStorage

Composite-key map.

private class
Memoizer.MemoizerKey

Key for composite-key map.

Field Summary

Modifier and TypeField and Description
private final ConcurrentMap<Memoizer<A, V>.MemoizerKey, Future<V>>
private final Memoizer<A, V>.KeyStorage

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public V
compute(final ComputableTask<A, V> c, final A
argument for computation
taskArg
)

Implements org.eclipse.persistence.internal.cache.LowLevelProcessor.compute.

Waits if necessary for the computation to complete, and then retrieves its result.
public void
forget(ComputableTask<A, V>
computable task, forming part of result key
task
,
A
argument of computation
key
)

Forgets result of the specified task.

public void
forgetAll()

Forgets all cached results.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cacheback to summary
private final ConcurrentMap<Memoizer<A, V>.MemoizerKey, Future<V>> cache
keyStorageback to summary
private final Memoizer<A, V>.KeyStorage keyStorage

Constructor Detail

Memoizerback to summary
public Memoizer()

Method Detail

computeback to summary
public V compute(final ComputableTask<A, V> c, final A taskArg) throws InterruptedException

Implements org.eclipse.persistence.internal.cache.LowLevelProcessor.compute.

Doc from org.eclipse.persistence.internal.cache.LowLevelProcessor.compute.

Waits if necessary for the computation to complete, and then retrieves its result.

Parameters
taskArg:A

argument for computation

Annotations
@Override
Exceptions
InterruptedException:
if the current thread was interrupted while waiting
forgetback to summary
public void forget(ComputableTask<A, V> task, A key)

Forgets result of the specified task. This allows to manually control size of internal cache.

Parameters
task:ComputableTask<A, V>

computable task, forming part of result key

key:A

argument of computation

forgetAllback to summary
public void forgetAll()

Forgets all cached results.

org.eclipse.persistence.internal.cache back to summary

private Class Memoizer.KeyStorage

extends Object
Class Inheritance

Composite-key map.

Field Summary

Modifier and TypeField and Description
pack-priv Map<Memoizer<A, V>.MemoizerKey, Memoizer<A, V>.MemoizerKey>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public Memoizer<A, V>.MemoizerKey
get(final ComputableTask<A, V> c, final A taskArg)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

mapback to summary
pack-priv Map<Memoizer<A, V>.MemoizerKey, Memoizer<A, V>.MemoizerKey> map

Constructor Detail

KeyStorageback to summary
private KeyStorage()

Method Detail

getback to summary
public Memoizer<A, V>.MemoizerKey get(final ComputableTask<A, V> c, final A taskArg)
org.eclipse.persistence.internal.cache back to summary

private Class Memoizer.MemoizerKey

extends Object
Class Inheritance

Key for composite-key map.

Field Summary

Modifier and TypeField and Description
private final A
private final ComputableTask<A, V>

Constructor Summary

AccessConstructor and Description
private
MemoizerKey(ComputableTask<A, V> task, A key)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

keyback to summary
private final A key
taskback to summary
private final ComputableTask<A, V> task

Constructor Detail

MemoizerKeyback to summary
private MemoizerKey(ComputableTask<A, V> task, A key)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override