com.samskivert.util

Class WeakObserverList<T>

java.lang.Object

com.samskivert.util.ObserverList<T>

com.samskivert.util.WeakObserverList<T>

public class WeakObserverList<T>
extends ObserverList<T>

An ObserverList equivalent that does not prevent added observers from being garbage-collected.

Nested Class Summary

Nested classes/interfaces inherited from class com.samskivert.util.ObserverList

ObserverList.ObserverOp<T>, ObserverList.Policy

Field Summary

Fields inherited from class com.samskivert.util.ObserverList

FAST_UNSAFE_NOTIFY, SAFE_IN_ORDER_NOTIFY

Method Summary

Modifier and Type	Method and Description
boolean	add(int index, T element) Adds an observer at the specified index.
boolean	add(T element) Adds an observer to the end of the list.
void	apply(ObserverList.ObserverOp<T> obop) Applies the supplied observer operation to all observers in the list in a manner conforming to the notification ordering policy specified at construct time.
void	clear() Clears all observers from the list.
static <T> WeakObserverList<T>	newFastUnsafe() Creates a list with ObserverList.Policy.FAST_UNSAFE notification policy.
static <T> WeakObserverList<T>	newList(ObserverList.Policy notifyPolicy) Creates a weak observer list with the specified notification policy.
static <T> WeakObserverList<T>	newSafeInOrder() Creates a list with ObserverList.Policy.SAFE_IN_ORDER notification policy.
void	prune() Removes all garbage-collected observers from the list.
boolean	remove(T element) Removes the specified observer from the list.
WeakObserverList<T>	setCheckDuplicates(boolean checkDuplicates) Configures this observer list to check duplicates when adding observers, or not.
int	size() Returns the number of observers in this list.

Methods inherited from class com.samskivert.util.ObserverList

isEmpty, newList

Methods inherited from class java.lang.Object

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

Method Detail

newSafeInOrder

public static <T> WeakObserverList<T> newSafeInOrder()

Creates a list with ObserverList.Policy.SAFE_IN_ORDER notification policy.

newFastUnsafe

public static <T> WeakObserverList<T> newFastUnsafe()

Creates a list with ObserverList.Policy.FAST_UNSAFE notification policy.

newList

public static <T> WeakObserverList<T> newList(ObserverList.Policy notifyPolicy)

Creates a weak observer list with the specified notification policy.

add

public boolean add(int index,
                   T element)

Description copied from class: ObserverList

Adds an observer at the specified index.

Specified by:

add in class ObserverList<T>

Returns:

true if the observer was added, false if it was already in the list.

add

public boolean add(T element)

Description copied from class: ObserverList

Adds an observer to the end of the list.

Specified by:

add in class ObserverList<T>

Returns:

true if the observer was added, false if it was already in the list.

remove

public boolean remove(T element)

Description copied from class: ObserverList

Removes the specified observer from the list.

Specified by:

remove in class ObserverList<T>

Returns:

true if the observer was located and removed, false if it does not exist.

apply

public void apply(ObserverList.ObserverOp<T> obop)

Description copied from class: ObserverList

Applies the supplied observer operation to all observers in the list in a manner conforming to the notification ordering policy specified at construct time.

Specified by:

apply in class ObserverList<T>

size

public int size()

Description copied from class: ObserverList

Returns the number of observers in this list.

Specified by:

size in class ObserverList<T>

clear

public void clear()

Description copied from class: ObserverList

Clears all observers from the list.

Specified by:

clear in class ObserverList<T>

setCheckDuplicates

public WeakObserverList<T> setCheckDuplicates(boolean checkDuplicates)

Description copied from class: ObserverList

Configures this observer list to check duplicates when adding observers, or not. By default duplicates are checked, but for performance reasons, one may wish to disable this check.

Specified by:

setCheckDuplicates in class ObserverList<T>

prune

public void prune()

Removes all garbage-collected observers from the list.