com.codelanx.codelanxlib.util.ref

Enum ReferenceType

java.lang.Object

java.lang.Enum<ReferenceType>

com.codelanx.codelanxlib.util.ref.ReferenceType

All Implemented Interfaces:

Serializable, Comparable<ReferenceType>

public enum ReferenceType
extends Enum<ReferenceType>

An enum representing the different types of references, as well as allowing a passed object to be converted to a reference of the relevant type

Since:

0.2.0

Version:

0.2.0

Author:

1Rogue

Enum Constant Summary

Enum Constants

Enum Constant and Description
PHANTOM
SOFT
STRONG
WEAK

Method Summary

Modifier and Type	Method and Description
<T> FlexReference<? extends T>	toSafeReference(T in) Converts the passed-in object to a reference of this constant's type
<T> FlexReference<? extends T>	toSafeReference(T in, ReferenceQueue<? extends T> queue) Converts the passed-in object to a reference of this constant's type
<T> Reference<? extends T>	toUnsafeReference(T in) Converts the passed-in object to a reference of this constant's type
<T> Reference<? extends T>	toUnsafeReference(T in, ReferenceQueue<? extends T> queue) Converts the passed-in object to a reference of this constant's type
static ReferenceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReferenceType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STRONG

public static final ReferenceType STRONG

WEAK

public static final ReferenceType WEAK

SOFT

public static final ReferenceType SOFT

PHANTOM

public static final ReferenceType PHANTOM

Method Detail

values

public static ReferenceType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReferenceType c : ReferenceType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReferenceType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toSafeReference

public <T> FlexReference<? extends T> toSafeReference(T in)

Converts the passed-in object to a reference of this constant's type

Type Parameters:

T - The type of the object

Parameters:

in - The object to hold a reference for

Returns:

A FlexReference to the relevant object

Since:

0.2.0

toUnsafeReference

public <T> Reference<? extends T> toUnsafeReference(T in)

Converts the passed-in object to a reference of this constant's type

Type Parameters:

T - The type of the object

Parameters:

in - The object to hold a reference for

Returns:

A Reference to the relevant object. Note however: Any strong references will be a wrapped WeakReference, and caution should be taken to not pass in the reference to anything which expects a WeakReference

Since:

0.2.0

toSafeReference

public <T> FlexReference<? extends T> toSafeReference(T in,
                                                      ReferenceQueue<? extends T> queue)

Converts the passed-in object to a reference of this constant's type

Type Parameters:

T - The type of the object

Parameters:

in - The object to hold a reference for

queue - A ReferenceQueue to register with the object

Returns:

A FlexReference to the relevant object

Since:

0.2.0

toUnsafeReference

public <T> Reference<? extends T> toUnsafeReference(T in,
                                                    ReferenceQueue<? extends T> queue)

Converts the passed-in object to a reference of this constant's type

Type Parameters:

T - The type of the object

Parameters:

in - The object to hold a reference for

queue - A ReferenceQueue to register with the object Note however: Any strong references will be a wrapped WeakReference, and caution should be taken to not pass in the reference to anything which expects a WeakReference

Returns:

A Reference to the relevant object.

Since:

0.2.0