com.codelanx.codelanxlib.util.ref

Class FlexReference<T>

java.lang.Object

com.codelanx.codelanxlib.util.ref.FlexReference<T>

Type Parameters:

T - The type of the reference

public class FlexReference<T>
extends Object

Holds a reference to an object, using either a strong reference, or any of the provided references in Java's provided references.

Since:

0.2.0

Version:

0.2.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
FlexReference(T object, ReferenceType type) Holds the passed in object and creates a reference if necessary
FlexReference(T object, ReferenceType type, ReferenceQueue<? extends T> queue) Holds the passed in object and creates a reference if necessary

Method Summary

Modifier and Type	Method and Description
boolean	enqueue() Attempts to insert the reference into the ReferenceQueue
T	get() Retrieves the current value of the reference
boolean	isEnqueued() Returns whether or not the object is enqueued.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexReference

public FlexReference(T object,
                     ReferenceType type)

Holds the passed in object and creates a reference if necessary

Parameters:

object - The object to hold a reference to

type - The type of reference to use

Since:

0.2.0

FlexReference

public FlexReference(T object,
                     ReferenceType type,
                     ReferenceQueue<? extends T> queue)

Holds the passed in object and creates a reference if necessary

Parameters:

object - The object to hold a reference to

type - The type of reference to use

queue - A backed ReferenceQueue for any constructed ref

Since:

0.2.0

Method Detail

get

public T get()

Retrieves the current value of the reference

Returns:

The current value, or null if the object has been GC'd

Since:

0.2.0

isEnqueued

public boolean isEnqueued()

Returns whether or not the object is enqueued. If the object is a strong reference, then this method always returns false

Returns:

true if the object is not a strong reference and the reference is enqueued

Since:

0.2.0

See Also:

Reference.isEnqueued()

enqueue

public boolean enqueue()

Attempts to insert the reference into the ReferenceQueue

Returns:

true if the object is not a strong reference and the reference is successfully enqueued for the first time

Since:

0.2.0

See Also:

Reference.enqueue()