Package org.wildfly.common.ref

Enum Reference.Type

java.lang.Object

java.lang.Enum<Reference.Type>

org.wildfly.common.ref.Reference.Type

Enclosing interface:

Reference<T,A>

public static enum Reference.Type
extends java.lang.Enum<Reference.Type>

A reference type.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NULL	A null reference.
PHANTOM	A phantom reference.
SOFT	A soft reference.
STRONG	A strong reference.
WEAK	A weak reference.

Method Summary

Modifier and Type	Method	Description
boolean	in(Reference.Type v1)	Determine whether this instance is equal to one of the given instances.
boolean	in(Reference.Type... values)	Determine whether this instance is equal to one of the given instances.
boolean	in(Reference.Type v1, Reference.Type v2)	Determine whether this instance is equal to one of the given instances.
boolean	in(Reference.Type v1, Reference.Type v2, Reference.Type v3)	Determine whether this instance is equal to one of the given instances.
static boolean	isFull(java.util.EnumSet<Reference.Type> set)	Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.
static Reference.Type	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Reference.Type[]	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 Reference.Type STRONG

A strong reference.

WEAK

public static final Reference.Type WEAK

A weak reference.

PHANTOM

public static final Reference.Type PHANTOM

A phantom reference.

SOFT

public static final Reference.Type SOFT

A soft reference.

NULL

public static final Reference.Type NULL

A null reference.

Method Detail

values

public static Reference.Type[] 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 (Reference.Type c : Reference.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static Reference.Type valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isFull

public static boolean isFull(java.util.EnumSet<Reference.Type> set)

Determine whether the given set is fully populated (or "full"), meaning it contains all possible values.

Parameters:

set - the set

Returns:

true if the set is full, false otherwise

in

public boolean in(Reference.Type v1)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(Reference.Type v1,
                  Reference.Type v2)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(Reference.Type v1,
                  Reference.Type v2,
                  Reference.Type v3)

Determine whether this instance is equal to one of the given instances.

Parameters:

v1 - the first instance

v2 - the second instance

v3 - the third instance

Returns:

true if one of the instances matches this one, false otherwise

in

public boolean in(Reference.Type... values)

Determine whether this instance is equal to one of the given instances.

Parameters:

values - the possible values

Returns:

true if one of the instances matches this one, false otherwise