org.apache.river.collection

Class WeakSoftTable.SoftValue

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.SoftReference

org.apache.river.collection.WeakSoftTable.SoftValue

All Implemented Interfaces:

WeakSoftTable.RemovableReference

Enclosing class:

WeakSoftTable

public static class WeakSoftTable.SoftValue
extends SoftReference
implements WeakSoftTable.RemovableReference

A value that maintains a soft reference to an object.

Field Summary

Fields

Modifier and Type	Field and Description
protected WeakSoftTable.WeakKey	key The associated key.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SoftValue(WeakSoftTable.SoftValue softValue, ReferenceQueue queue) Creates a copy of the value registered with the queue.
	SoftValue(WeakSoftTable.WeakKey key, Object value) Creates a value for the associated key that retains a soft reference to value.

Method Summary

Modifier and Type	Method and Description
void	cleared(Map map) Called with the containing map when this instance's reference is cleared, to remove the associated entry from the map.
WeakSoftTable.RemovableReference	copy(ReferenceQueue queue) Returns a copy of this instance registered with the specified queue.

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

Field Detail

key

protected final WeakSoftTable.WeakKey key

The associated key. Used to remove the hash table entry when the value is cleared.

Constructor Detail

SoftValue

public SoftValue(WeakSoftTable.WeakKey key,
                 Object value)

Creates a value for the associated key that retains a soft reference to value.

SoftValue

protected SoftValue(WeakSoftTable.SoftValue softValue,
                    ReferenceQueue queue)

Creates a copy of the value registered with the queue.

Method Detail

copy

public WeakSoftTable.RemovableReference copy(ReferenceQueue queue)

Description copied from interface: WeakSoftTable.RemovableReference

Returns a copy of this instance registered with the specified queue.

Specified by:

copy in interface WeakSoftTable.RemovableReference

Parameters:

queue - the queue with which this instance should be registered

Returns:

the copy

cleared

public void cleared(Map map)

Description copied from interface: WeakSoftTable.RemovableReference

Called with the containing map when this instance's reference is cleared, to remove the associated entry from the map.

Specified by:

cleared in interface WeakSoftTable.RemovableReference

Parameters:

map - the map from which this newly cleared instance should be removed