de.mrapp.util.datastructure

Class ListenerList<T>

java.lang.Object

de.mrapp.util.datastructure.ListenerList<T>

All Implemented Interfaces:

java.lang.Iterable<T>

public class ListenerList<T>
extends java.lang.Object
implements java.lang.Iterable<T>

A list, which is meant to be used for managing event listeners. The list ensures, that no duplicates or null elements can be added. For comparing listeners either the Object.equals(Object) method or the identity operator (==) can be used. Furthermore, this class is thread-safe and no ConcurrentModificationExceptions are thrown when adding or removing listeners while iterating the list.

This is list is neither serializable, nor does it override the Object.equals(Object) or Object.hashCode() method.

Since:

1.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListenerList.CompareMethod Contains all possible methods for comparing listeners with each other.

Constructor Summary

Constructors

Constructor and Description
ListenerList() Creates a new list, which is meant to be used for managing event listeners.
ListenerList(@NotNull ListenerList.CompareMethod compareMethod) Creates a new list, which is meant to be used for managing event listeners.

Method Summary

Modifier and Type	Method and Description
boolean	add(T listener) Adds a new listener to the list.
void	addAll(@NotNull java.lang.Iterable<? extends T> iterable) Adds all listeners, which can be iterated using a specific iterable, to the list.
void	clear() Removes all listeners from the list.
@NotNull java.util.Collection<T>	getAll() Returns a collection, which contains all listeners, which are currently contained by the list.
@NotNull ListenerList.CompareMethod	getCompareMethod() Returns the compare method, which is used by the list.
boolean	isEmpty() Returns, whether the list is empty, or not.
@NotNull java.util.Iterator<T>	iterator()
boolean	remove(T listener) Removes a specific listener from the list.
void	removeAll(@NotNull java.lang.Iterable<? extends T> iterable) Removes all listeners, which can be iterated using a specific iterable.
int	size() Returns the number of listeners, which are contained by the list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ListenerList

public ListenerList()

Creates a new list, which is meant to be used for managing event listeners. In order to prevent duplicates, listeners are compared using the Object.equals(Object) method.

ListenerList

public ListenerList(@NotNull
                    @NotNull ListenerList.CompareMethod compareMethod)

Creates a new list, which is meant to be used for managing event listeners. In order to prevent duplicates, a specific compare method is used.

Parameters:

compareMethod - The method, which should be used for comparing listeners to each other, as a value of the enum ListenerList.CompareMethod. The compare method may not be null

Method Detail

getCompareMethod

@NotNull
public final @NotNull ListenerList.CompareMethod getCompareMethod()

Returns the compare method, which is used by the list.

Returns:

The compare method, which is used by the list, as a value of the enum ListenerList.CompareMethod. The compare method may not be null

isEmpty

public final boolean isEmpty()

Returns, whether the list is empty, or not.

Returns:

True, if the list is empty, false otherwise

size

public final int size()

Returns the number of listeners, which are contained by the list.

Returns:

The number of listeners, which are contained by the list, as an Integer value

add

public final boolean add(@NotNull
                         T listener)

Adds a new listener to the list.

Parameters:

listener - The listener, which should be added, as an instance of the generic type T. The listener may not be null

Returns:

True, if the listener has been added, or false, if the listener was already contained by the list

addAll

public final void addAll(@NotNull
                         @NotNull java.lang.Iterable<? extends T> iterable)

Adds all listeners, which can be iterated using a specific iterable, to the list.

Parameters:

iterable - The iterable as an instance of the type Iterable. The iterable may not be null

remove

public final boolean remove(@NotNull
                            T listener)

Removes a specific listener from the list.

Parameters:

listener - The listener, which should be removed, as an instance of the generic type T. The listener may not be null

Returns:

True, if the listener has been removed, or false, if the listener is not contained by the list

removeAll

public final void removeAll(@NotNull
                            @NotNull java.lang.Iterable<? extends T> iterable)

Removes all listeners, which can be iterated using a specific iterable.

Parameters:

iterable - The iterable as an instance of the type Iterable. The iterable may not be null

clear

public final void clear()

Removes all listeners from the list.

getAll

@NotNull
public @NotNull java.util.Collection<T> getAll()

Returns a collection, which contains all listeners, which are currently contained by the list. The returned collection is a snapshot of the current state and is unmodifiable.

Returns:

A collection, which contains all listeners, which are currently contained by the list, as an instance of the type Collection. The collection may not be null

iterator

@NotNull
public @NotNull java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>