Package com.globalmentor.collections

Class PurgeOnWriteSoftValueHashMap.SoftValueReference<K,V>

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.SoftReference<V>

com.globalmentor.collections.PurgeOnWriteSoftValueHashMap.SoftValueReference<K,V>

Type Parameters:

K - The type of key.

V - The type of value.

All Implemented Interfaces:

AbstractPurgeOnWriteReferenceValueMap.Keyed<K>

Enclosing class:

PurgeOnWriteSoftValueHashMap<K,V>

public static class PurgeOnWriteSoftValueHashMap.SoftValueReference<K,V>
extends SoftReference<V>
implements AbstractPurgeOnWriteReferenceValueMap.Keyed<K>

A soft reference that keeps track of the key with which a value was associated.

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor	Description
SoftValueReference(K key, V value, ReferenceQueue<? super V> referenceQueue)	Creates a new soft reference that remembers the given key, refers to the given object, and is registered with the given queue.

Method Summary

Modifier and Type	Method	Description
K	getKey()

Methods inherited from class java.lang.ref.SoftReference

get

Methods inherited from class java.lang.ref.Reference

clear, enqueue, isEnqueued

Methods inherited from class java.lang.Object

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

Constructor Details

SoftValueReference

public SoftValueReference(K key,
 V value,
 ReferenceQueue<? super V> referenceQueue)

Creates a new soft reference that remembers the given key, refers to the given object, and is registered with the given queue.

Parameters:

key - The key with which the value is being associated.

value - The value to which the new soft reference will refer.

referenceQueue - The queue with which the reference is to be registered.

Throws:

NullPointerException - if the given reference queue is null.

Method Details

getKey

public K getKey()

Specified by:

getKey in interface AbstractPurgeOnWriteReferenceValueMap.Keyed<K>

Returns:

They key with which the referent value was associated.