com.github.wuic.nut

Enum NutsHeap.ListenerHolder

java.lang.Object

java.lang.Enum<NutsHeap.ListenerHolder>

com.github.wuic.nut.NutsHeap.ListenerHolder

All Implemented Interfaces:

Serializable, Comparable<NutsHeap.ListenerHolder>

Enclosing class:

NutsHeap

public static enum NutsHeap.ListenerHolder
extends Enum<NutsHeap.ListenerHolder>

The NutsHeap is a NutDaoListener registered in the NutDao. Because the listeners are registered in weak references, we must make sure a strong reference prevents the objects from garbage collection. This class helps to keep a strong reference to the registered listener.

Since:

0.5.1

Version:

1.0

Author:

Guillaume DROUET

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(HeapListener l) Adds a strong reference to the listener.
void	clear() Clears all strong references.
static NutsHeap.ListenerHolder	valueOf(String name) Returns the enum constant of this type with the specified name.
static NutsHeap.ListenerHolder[]	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

INSTANCE

public static final NutsHeap.ListenerHolder INSTANCE

Singleton.

Method Detail

values

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

Returns:

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

valueOf

public static NutsHeap.ListenerHolder 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

add

public void add(HeapListener l)

Adds a strong reference to the listener.

Parameters:

l - the listener

clear

public void clear()

Clears all strong references.