Class WeakReference<T,A>

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.WeakReference<T>

org.jboss.modules.ref.WeakReference<T,A>

Type Parameters:

T - the reference value type

A - the attachment type

All Implemented Interfaces:

Reapable<T,A>, Reference<T,A>

public class WeakReference<T,A>
extends WeakReference<T>
implements Reference<T,A>, Reapable<T,A>

A reapable weak reference with an attachment. If a Reaper is given, then it will be used to asynchronously clean up the referent.

See Also:

• WeakReference

Nested Class Summary

Nested classes/interfaces inherited from interface Reference

Reference.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final A	attachment
private final Reaper<T,A>	reaper

Constructor Summary

Constructors

Constructor	Description
WeakReference(T referent)
WeakReference(T referent, A attachment)
WeakReference(T referent, A attachment, ReferenceQueue<? super T> q)
WeakReference(T referent, A attachment, Reaper<T,A> reaper)

Method Summary

Modifier and Type	Method	Description
A	getAttachment()	Get the attachment, if any.
Reaper<T,A>	getReaper()	Get the associated reaper.
Reference.Type	getType()	Get the type of the reference.
String	toString()

Methods inherited from class Reference

clear, clone, enqueue, get, isEnqueued, reachabilityFence, refersTo

Methods inherited from class Object

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

Methods inherited from interface Reference

clear, get

Field Details

attachment

private final A attachment

reaper

private final Reaper<T,A> reaper

Constructor Details

WeakReference

public WeakReference(T referent)

WeakReference

public WeakReference(T referent,
 A attachment)

WeakReference

public WeakReference(T referent,
 A attachment,
 ReferenceQueue<? super T> q)

WeakReference

public WeakReference(T referent,
 A attachment,
 Reaper<T,A> reaper)

Method Details

getAttachment

public A getAttachment()

Description copied from interface: Reference

Get the attachment, if any.

Specified by:

getAttachment in interface Reference<T,A>

Returns:

the attachment

getType

public Reference.Type getType()

Description copied from interface: Reference

Get the type of the reference.

Specified by:

getType in interface Reference<T,A>

Returns:

the type

getReaper

public Reaper<T,A> getReaper()

Description copied from interface: Reapable

Get the associated reaper.

Specified by:

getReaper in interface Reapable<T,A>

Returns:

the reaper

toString

public String toString()

Overrides:

toString in class Object