Package org.apache.xmlgraphics.image.loader.util

Class SoftReferenceWithKey

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.SoftReference

org.apache.xmlgraphics.image.loader.util.SoftReferenceWithKey

public class SoftReferenceWithKey
extends java.lang.ref.SoftReference

Special SoftReference subclass that holds an additional key object that can be used to remove a reference from a Map once the referenced object is collected, for example.

Constructor Summary

Constructors

Constructor	Description
SoftReferenceWithKey(java.lang.Object referent, java.lang.Object key, java.lang.ref.ReferenceQueue q)	Creates a new SoftReference with a key.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getKey()	Returns the key associated with this reference.

Methods inherited from class java.lang.Object

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

Methods inherited from class java.lang.ref.Reference

clear, enqueue, isEnqueued, reachabilityFence

Methods inherited from class java.lang.ref.SoftReference

get

Constructor Detail

SoftReferenceWithKey

public SoftReferenceWithKey(java.lang.Object referent,
                            java.lang.Object key,
                            java.lang.ref.ReferenceQueue q)

Creates a new SoftReference with a key.

Parameters:

referent - object the new soft reference will refer to

key - the key object

q - queue the soft reference is registered with

Method Detail

getKey

public java.lang.Object getKey()

Returns the key associated with this reference.

Returns:

the key