org.wildfly.common.ref

Class SoftReference<T,A>

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.SoftReference<T>

org.wildfly.common.ref.SoftReference<T,A>

Type Parameters:

T - the reference value type

A - the attachment type

All Implemented Interfaces:

Reference<T,A>

public class SoftReference<T,A>
extends SoftReference<T>
implements Reference<T,A>

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

Author:

David M. Lloyd

See Also:

SoftReference

Nested Class Summary

Nested classes/interfaces inherited from interface org.wildfly.common.ref.Reference

Reference.Type

Constructor Summary

Constructors

Constructor and Description
SoftReference(T referent) Construct a new instance.
SoftReference(T referent, A attachment) Construct a new instance.
SoftReference(T referent, A attachment, Reaper<T,A> reaper) Construct a new instance with a reaper.
SoftReference(T referent, A attachment, ReferenceQueue<? super T> q) Construct a new instance with an explicit reference queue.

Method Summary

Methods

Modifier and Type	Method and 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 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, wait, wait, wait

Methods inherited from interface org.wildfly.common.ref.Reference

clear, get

Constructor Detail

SoftReference

public SoftReference(T referent)

Construct a new instance.

Parameters:

referent - the referent

SoftReference

public SoftReference(T referent,
             A attachment)

Construct a new instance.

Parameters:

referent - the referent

attachment - the attachment

SoftReference

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

Construct a new instance with an explicit reference queue.

Parameters:

referent - the referent

attachment - the attachment

q - the reference queue to use

SoftReference

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

Construct a new instance with a reaper.

Parameters:

referent - the referent

attachment - the attachment

reaper - the reaper to use

Method Detail

getReaper

public Reaper<T,A> getReaper()

Get the associated reaper.

Returns:

the reaper

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

toString

public String toString()

Overrides:

toString in class Object