de.skuzzle.jeve.stores

Class AbstractListenerStore

java.lang.Object

de.skuzzle.jeve.stores.AbstractListenerStore

All Implemented Interfaces:

ListenerStore

public abstract class AbstractListenerStore
extends Object
implements ListenerStore

Abstract helper class for implementing your own ListenerStores.

Since:

3.0.0

Author:

Simon Taddiken

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_SIZE_HINT The default size hint for createListenerList()

Constructor Summary

Constructors

Constructor and Description
AbstractListenerStore()

Method Summary

Modifier and Type	Method and Description
<T extends Listener> void	add(T listener) Adds the given object for all listener classes it implements.
protected <T extends Listener> Collection<T>	copyList(Class<T> listenerClass, Stream<Object> listeners, int sizeHint) Creates a collection from the given stream, casting each object to the provided listener class.
protected <T> List<T>	createListenerList() Returns the List object to store listeners in.
protected abstract <T> List<T>	createListenerList(int sizeHint) Returns the List object to store listeners in.
<T extends Listener> void	remove(T listener) Removes the given object for all listener classes it implements.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.skuzzle.jeve.ListenerStore

add, clearAll, clearAll, close, get, isSequential, remove, synchronizedView

Field Detail

DEFAULT_SIZE_HINT

protected static final int DEFAULT_SIZE_HINT

The default size hint for createListenerList()

See Also:

Constant Field Values

Constructor Detail

AbstractListenerStore

public AbstractListenerStore()

Method Detail

createListenerList

protected abstract <T> List<T> createListenerList(int sizeHint)

Returns the List object to store listeners in.

Type Parameters:

T - Type of the resulting List.

Parameters:

sizeHint - The expected initial size of the list to create.

Returns:

A new List instance.

createListenerList

protected final <T> List<T> createListenerList()

Returns the List object to store listeners in.

Type Parameters:

T - Type of the resulting List.

Returns:

A new List instance.

copyList

protected <T extends Listener> Collection<T> copyList(Class<T> listenerClass,
                                                      Stream<Object> listeners,
                                                      int sizeHint)

Creates a collection from the given stream, casting each object to the provided listener class. The returned collection must not necessarily be mutable.

Type Parameters:

T - Type of the listeners in the given list.

Parameters:

listenerClass - The class of the objects in the provided list.

listeners - The stream to obtain the listeners for the resulting collection from.

sizeHint - Expected size of the input stream.

Returns:

A typed copy of the list.

add

public <T extends Listener> void add(T listener)

Description copied from interface: ListenerStore

Adds the given object for all listener classes it implements. This recursively traverses super classes and super interfaces of the given listener's class. When encountering a super interface X which

1. is not Listener.class but
2. can be assigned to Listener.class and
3. is not annotated with ListenerKind.TAGGING

then the given listener will be registered for X. Otherwise, all super interfaces of X are processed in the same way. When all super interfaces have been processed, the same process is recursively applied to the super class of the given listener if it has one. The "otherwise" implies, that the inheritance hierarchy of classes which have already been recognized as target listener class will not be traversed. If the same listener class is encountered multiple times while traversing the hierarchy, the listener will still only be registered once for that class.

Note that for each class the listener is being added its onRegister method is called.

Specified by:

add in interface ListenerStore

Type Parameters:

T - Type of the listener.

Parameters:

listener - The listener to add.

remove

public <T extends Listener> void remove(T listener)

Description copied from interface: ListenerStore

Removes the given object for all listener classes it implements. See ListenerStore.add(Listener) to learn how these classes are collected from the given listener. If the same listener has been added multiple times for the same listener class, only one reference will be removed. This is compatible with the definition of ListenerStore.remove(Class, Listener), which also only removes one reference of the listener.

Note that for each class the listener is being removed its onUnregister method is called.

Specified by:

remove in interface ListenerStore

Type Parameters:

T - Type of the listener.

Parameters:

listener - The listener to remove.