de.skuzzle.jeve

Class DefaultTargetEvent<T,S extends Event<?,L>,L extends Listener>

java.lang.Object

de.skuzzle.jeve.Event<T,L>

de.skuzzle.jeve.DefaultTargetEvent<T,S,L>

Type Parameters:

T - Type of the source of this event.

S - The concrete type of the extending class.

L - Type of the listener which can handle this event.

Deprecated.

Since 3.0.0 - use DefaultDispatchable instead.

@Deprecated
public abstract class DefaultTargetEvent<T,S extends Event<?,L>,L extends Listener>
extends Event<T,L>

Provides a convenient way to implement Listeners which only have a single listening method. If a listener only has a single listening method, it is redundant to specify it when calling the EventProvider's dispatch method. As dispatch may be called often for some kind of events, it is easier to statically provide the method reference to the listening method. That is what this event class is for.

Due to Java's type system, this kind of events need a third type parameter SELF which must be set to the class you are implementing. Here is a sample implementation:

 
 public class UserEvent extends DefaultTargetEvent<UserManager, UserEvent, UserListener> {

     public UserEvent(UserManager source) {
         super(source, UserListener.class);
     }

     @Override
     public BiConsumer<UserListener, UserEvent> getTarget() {
         return UserListener::userAdded;
     }
 }
 
 

As you can see, the middle parameter is set to the implementing class's name itself to be available as type parameter for the return type of getTarget(). Thereby, these events are completely compatible with the EventProvider's dispatch method:

 eventProvider.dispatch(event, event.getTarget())
 

This allows for the creation of a more convenient dispatch overload which only takes the event as parameter and internally delegates to the above shown overload:

 eventProvider.dispatch(event)
 

Since:

2.0.0

Author:

Simon Taddiken

See Also:

Event

Constructor Summary

Constructors

Constructor and Description
DefaultTargetEvent(T source, Class<L> listenerClass) Deprecated. Creates a new event with a given source.

Method Summary

Modifier and Type	Method and Description
abstract BiConsumer<L,S>	getTarget() Deprecated.

Methods inherited from class de.skuzzle.jeve.Event

getListenerClass, getListenerStore, getProperties, getSource, getValue, getValueAs, isHandled, isPrevented, setHandled, setListenerStore, setPrevented, setValue, stopNotifying

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTargetEvent

public DefaultTargetEvent(T source,
                          Class<L> listenerClass)

Deprecated.

Creates a new event with a given source.

Parameters:

source - The source of this event.

listenerClass - The type of the listener which can handle this event. This value must not be null.

Method Detail

getTarget

@Deprecated
public abstract BiConsumer<L,S> getTarget()

Deprecated.

Returns a method reference to the method of the listener which should be called with this event.

Returns:

A method reference to a listening method of a listener.