Skip navigation links

org.apache.myfaces.trinidad.util.ref
Class StrongPseudoReference<T>

java.lang.Object
org.apache.myfaces.trinidad.util.ref.StrongPseudoReference<T>

All Implemented Interfaces:

PseudoReference<T>

public final class StrongPseudoReference<T>

extends Object

implements PseudoReference<T>

Implementation of PseudoReferences holding a strong reference to the referent.

Method Summary

void	clear() Clears this reference object.
boolean	enqueue() Adds this reference object to the queue with which it is registered, if any.
T	get() Returns this reference object's referent.
boolean	isEnqueued() Tells whether or not this reference object has been enqueued, either by the program or by the garbage collector.
static <S> StrongPseudoReference<S>	newStrongPseudoReference(S referent) Returns a new StrongPseudoReference with a strong reference to the referent;

Methods inherited from class java.lang.Object

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

Method Detail

newStrongPseudoReference

public static <S> StrongPseudoReference<S> newStrongPseudoReference(S referent)

Returns a new StrongPseudoReference with a strong reference to the referent;

Parameters:

referent -

Returns:

get

public T get()

Returns this reference object's referent. If this reference object has been cleared, either by the program or by the garbage collector, then this method returns null.

Specified by:

get in interface PseudoReference<T>

Returns:

The object to which this reference refers, or null if this reference object has been cleared

clear

public void clear()

Clears this reference object. Invoking this method will not cause this object to be enqueued.

This method is invoked only by Java code; when the garbage collector clears references it does so directly, without invoking this method.

Specified by:

clear in interface PseudoReference<T>

isEnqueued

public boolean isEnqueued()

Tells whether or not this reference object has been enqueued, either by the program or by the garbage collector. If this reference object was not registered with a queue when it was created, then this method will always return false.

Specified by:

isEnqueued in interface PseudoReference<T>

Returns:

true if and only if this reference object has been enqueued

enqueue

public boolean enqueue()

Adds this reference object to the queue with which it is registered, if any.

This method is invoked only by Java code; when the garbage collector enqueues references it does so directly, without invoking this method.

Specified by:

enqueue in interface PseudoReference<T>

Returns:

true if this reference object was successfully enqueued; false if it was already enqueued or if it was not registered with a queue when it was created

Skip navigation links