de.cismet.commons.ref

Class TimedSoftReference<T>

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.SoftReference<T>

de.cismet.commons.ref.TimedSoftReference<T>

public final class TimedSoftReference<T>
extends SoftReference<T>

Special implementation of SoftReference that purges the referent after the given idle time. Idle time in this case means time without access to the actual referent via get()

Version:

1.0

Author:

martin.scholl@cismet.de

See Also:

SoftReference}

Constructor Summary

Constructors

Constructor and Description
TimedSoftReference(T referent, long purgeAfterIdleTime) Creates a new TimedSoftReference object.
TimedSoftReference(T referent, ReferenceQueue<? super T> q, long purgeAfterIdleTime) Creates a new TimedSoftReference object.

Method Summary

Modifier and Type	Method and Description
T	get() Gets the actual value of this SoftReference (the referent).

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 Detail

TimedSoftReference

public TimedSoftReference(T referent,
                          long purgeAfterIdleTime)

Creates a new TimedSoftReference object. Actually using this constructor is equal to calling new TimedSoftReference(referent, null, purgeAfterIdleTime)

Parameters:

referent - the actual value

purgeAfterIdleTime - the time after a non-accessed referent will be removed

See Also:

#TimedSoftReference(java.lang.Object, java.lang.ref.ReferenceQueue, long)}

TimedSoftReference

public TimedSoftReference(T referent,
                          ReferenceQueue<? super T> q,
                          long purgeAfterIdleTime)

Creates a new TimedSoftReference object.

Parameters:

referent - the actual value

q - a reference queue to be used

purgeAfterIdleTime - the time after a non-accessed referent will be removed

See Also:

SoftReference}, #get()}

Method Detail

get

public T get()

Gets the actual value of this SoftReference (the referent). The actual value may not be present anymore for reasons explained in SoftReference javadoc or because the value has not been accessed for purgeAfterIdleTime milliseconds. As soon as the value has been accessed (and the referent is still existing) the purge operation is rescheduled to take place after purgeAfterIdleTime milliseconds.

Overrides:

get in class SoftReference<T>

Returns:

the actual value (the referent) or null if it has been cleaned for any reason

See Also:

SoftReference#get()}