Interface EventEmitter
-
- All Implemented Interfaces:
public interface EventEmitter<EventType extends Object>
-
-
Method Summary
Modifier and Type Method Description abstract EventEmitter<EventType>on(EventType event, Function0<Object> handler)Bind an event listener to fire when an event occurs. abstract <T extends Any> EventEmitter<EventType>on(EventType event, Function1<T, Object> handler)Bind an event listener to fire when an event occurs. abstract <T extends Any, T2 extends Any> EventEmitter<EventType>on(EventType event, Function2<T, T2, Object> handler)Bind an event listener to fire when an event occurs. abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType>on(EventType event, Function3<T, T2, T3, Object> handler)Bind an event listener to fire when an event occurs. abstract EventEmitter<EventType>on1(EventType event, SuspendFunction0<Object> handler)abstract <T extends Any> EventEmitter<EventType>on1(EventType event, SuspendFunction1<T, Object> handler)abstract <T extends Any, T2 extends Any> EventEmitter<EventType>on1(EventType event, SuspendFunction2<T, T2, Object> handler)abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType>on1(EventType event, SuspendFunction3<T, T2, T3, Object> handler)abstract List<Object>emit(EventType event)Emit an event and call any associated listeners. abstract <T extends Any> List<Object>emit(EventType event, T param)Emit an event and call any associated listeners. abstract <T extends Any, T2 extends Any> List<Object>emit(EventType event, T param, T2 param2)Emit an event and call any associated listeners. abstract <T extends Any, T2 extends Any, T3 extends Any> List<Object>emit(EventType event, T param, T2 param2, T3 param3)Emit an event and call any associated listeners. abstract List<Object>emit1(EventType event)abstract <T extends Any> List<Object>emit1(EventType event, T param)abstract <T extends Any, T2 extends Any> List<Object>emit1(EventType event, T param, T2 param2)abstract <T extends Any, T2 extends Any, T3 extends Any> List<Object>emit1(EventType event, T param, T2 param2, T3 param3)abstract EventEmitter<EventType>off(EventType event)Removes all listeners. abstract <T extends Any> EventEmitter<EventType>off(EventType event, Function0<Object> handler)Remove an event listener from firing. abstract <T extends Any> EventEmitter<EventType>off(EventType event, Function1<T, Object> handler)Remove an event listener from firing. abstract <T extends Any, T2 extends Any> EventEmitter<EventType>off(EventType event, Function2<T, T2, Object> handler)Remove an event listener from firing. abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType>off(EventType event, Function3<T, T2, T3, Object> handler)Remove an event listener from firing. abstract EventEmitter<EventType>off1(EventType event)abstract <T extends Any> EventEmitter<EventType>off1(EventType event, SuspendFunction0<Object> handler)abstract <T extends Any> EventEmitter<EventType>off1(EventType event, SuspendFunction1<T, Object> handler)abstract <T extends Any, T2 extends Any> EventEmitter<EventType>off1(EventType event, SuspendFunction2<T, T2, Object> handler)abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType>off1(EventType event, SuspendFunction3<T, T2, T3, Object> handler)abstract <T extends Any> EventEmitter<EventType>once(EventType event, Function1<T, Object> handler, T param)Like onbut the listener will only be fired once and then it will be removed.abstract <T extends Any, T2 extends Any> EventEmitter<EventType>once(EventType event, Function2<T, T2, Object> handler, T param, T2 param2)Like onbut the listener will only be fired once and then it will be removed.abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType>once(EventType event, Function3<T, T2, T3, Object> handler, T param, T2 param2, T3 param3)Like onbut the listener will only be fired once, and then it will be removed.abstract <T extends Any> EventEmitter<EventType>once1(EventType event, SuspendFunction1<T, Object> handler, T param)abstract <T extends Any, T2 extends Any> EventEmitter<EventType>once1(EventType event, SuspendFunction2<T, T2, Object> handler, T param, T2 param2)abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType>once1(EventType event, SuspendFunction3<T, T2, T3, Object> handler, T param, T2 param2, T3 param3)abstract BooleanhasListeners(EventType event)Check if the given event listener is registered BooleanhasNormalListeners(EventType event)Check if the given normal event listener is registered BooleanhasSuspendListeners(EventType event)Check if the given suspend event listener is registered abstract List<Function<Object>>listeners()Get a list of the registered event listeners abstract List<Function<Object>>listeners(EventType event)Get a list of the registered event listeners with the given type List<Function<Object>>normalListeners()Get a list of the registered normal event listeners List<Function<Object>>normalListeners(EventType event)Get a list of the registered normal event listeners with the given type List<Function<Object>>suspendListeners()Get a list of the registered suspend event listeners List<Function<Object>>suspendListeners(EventType event)Get a list of the registered suspend event listeners with the given type abstract Integercount(EventType event)Gets the number of listeners for a given event. -
-
Method Detail
-
on
abstract EventEmitter<EventType> on(EventType event, Function0<Object> handler)
Bind an event listener to fire when an event occurs.
- Parameters:
event-the event type you'd like to listen to. Can be a string or symbol.
handler-the function to be called when the event occurs.
-
on
abstract <T extends Any> EventEmitter<EventType> on(EventType event, Function1<T, Object> handler)
Bind an event listener to fire when an event occurs.
- Parameters:
event-the event type you'd like to listen to. Can be a string or symbol.
handler-the function to be called when the event occurs.
-
on
abstract <T extends Any, T2 extends Any> EventEmitter<EventType> on(EventType event, Function2<T, T2, Object> handler)
Bind an event listener to fire when an event occurs.
- Parameters:
event-the event type you'd like to listen to. Can be a string or symbol.
handler-the function to be called when the event occurs.
-
on
abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType> on(EventType event, Function3<T, T2, T3, Object> handler)
Bind an event listener to fire when an event occurs.
- Parameters:
event-the event type you'd like to listen to. Can be a string or symbol.
handler-the function to be called when the event occurs.
-
on1
abstract EventEmitter<EventType> on1(EventType event, SuspendFunction0<Object> handler)
-
on1
abstract <T extends Any> EventEmitter<EventType> on1(EventType event, SuspendFunction1<T, Object> handler)
-
on1
abstract <T extends Any, T2 extends Any> EventEmitter<EventType> on1(EventType event, SuspendFunction2<T, T2, Object> handler)
-
on1
abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType> on1(EventType event, SuspendFunction3<T, T2, T3, Object> handler)
-
emit
abstract List<Object> emit(EventType event)
Emit an event and call any associated listeners.
- Parameters:
event-the event you'd like to emit
-
emit
abstract <T extends Any> List<Object> emit(EventType event, T param)
Emit an event and call any associated listeners.
- Parameters:
event-the event you'd like to emit
param-any data you'd like to emit with the event
-
emit
abstract <T extends Any, T2 extends Any> List<Object> emit(EventType event, T param, T2 param2)
Emit an event and call any associated listeners.
- Parameters:
event-the event you'd like to emit
param-any data you'd like to emit with the event
-
emit
abstract <T extends Any, T2 extends Any, T3 extends Any> List<Object> emit(EventType event, T param, T2 param2, T3 param3)
Emit an event and call any associated listeners.
- Parameters:
event-the event you'd like to emit
param-any data you'd like to emit with the event
-
emit1
abstract <T extends Any, T2 extends Any> List<Object> emit1(EventType event, T param, T2 param2)
-
emit1
abstract <T extends Any, T2 extends Any, T3 extends Any> List<Object> emit1(EventType event, T param, T2 param2, T3 param3)
-
off
abstract EventEmitter<EventType> off(EventType event)
Removes all listeners. If given an event argument, it will remove only listeners for that event.
- Parameters:
event-the event to remove listeners for.
-
off
abstract <T extends Any> EventEmitter<EventType> off(EventType event, Function0<Object> handler)
Remove an event listener from firing.
- Parameters:
event-the event type you'd like to stop listening to.
handler-the function that should be removed.
-
off
abstract <T extends Any> EventEmitter<EventType> off(EventType event, Function1<T, Object> handler)
Remove an event listener from firing.
- Parameters:
event-the event type you'd like to stop listening to.
handler-the function that should be removed.
-
off
abstract <T extends Any, T2 extends Any> EventEmitter<EventType> off(EventType event, Function2<T, T2, Object> handler)
Remove an event listener from firing.
- Parameters:
event-the event type you'd like to stop listening to.
handler-the function that should be removed.
-
off
abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType> off(EventType event, Function3<T, T2, T3, Object> handler)
Remove an event listener from firing.
- Parameters:
event-the event type you'd like to stop listening to.
handler-the function that should be removed.
-
off1
abstract EventEmitter<EventType> off1(EventType event)
-
off1
abstract <T extends Any> EventEmitter<EventType> off1(EventType event, SuspendFunction0<Object> handler)
-
off1
abstract <T extends Any> EventEmitter<EventType> off1(EventType event, SuspendFunction1<T, Object> handler)
-
off1
abstract <T extends Any, T2 extends Any> EventEmitter<EventType> off1(EventType event, SuspendFunction2<T, T2, Object> handler)
-
off1
abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType> off1(EventType event, SuspendFunction3<T, T2, T3, Object> handler)
-
once
abstract <T extends Any> EventEmitter<EventType> once(EventType event, Function1<T, Object> handler, T param)
Like
onbut the listener will only be fired once and then it will be removed.- Parameters:
event-the event you'd like to listen to
handler-the handler function to run when the event occurs
-
once
abstract <T extends Any, T2 extends Any> EventEmitter<EventType> once(EventType event, Function2<T, T2, Object> handler, T param, T2 param2)
Like
onbut the listener will only be fired once and then it will be removed.- Parameters:
event-the event you'd like to listen to
handler-the handler function to run when the event occurs
-
once
abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType> once(EventType event, Function3<T, T2, T3, Object> handler, T param, T2 param2, T3 param3)
Like
onbut the listener will only be fired once, and then it will be removed.- Parameters:
event-the event you'd like to listen to
handler-the handler function to run when the event occurs
-
once1
abstract <T extends Any> EventEmitter<EventType> once1(EventType event, SuspendFunction1<T, Object> handler, T param)
-
once1
abstract <T extends Any, T2 extends Any> EventEmitter<EventType> once1(EventType event, SuspendFunction2<T, T2, Object> handler, T param, T2 param2)
-
once1
abstract <T extends Any, T2 extends Any, T3 extends Any> EventEmitter<EventType> once1(EventType event, SuspendFunction3<T, T2, T3, Object> handler, T param, T2 param2, T3 param3)
-
hasListeners
abstract Boolean hasListeners(EventType event)
Check if the given event listener is registered
-
hasNormalListeners
Boolean hasNormalListeners(EventType event)
Check if the given normal event listener is registered
-
hasSuspendListeners
Boolean hasSuspendListeners(EventType event)
Check if the given suspend event listener is registered
-
listeners
abstract List<Function<Object>> listeners(EventType event)
Get a list of the registered event listeners with the given type
-
normalListeners
List<Function<Object>> normalListeners()
Get a list of the registered normal event listeners
-
normalListeners
List<Function<Object>> normalListeners(EventType event)
Get a list of the registered normal event listeners with the given type
-
suspendListeners
List<Function<Object>> suspendListeners()
Get a list of the registered suspend event listeners
-
suspendListeners
List<Function<Object>> suspendListeners(EventType event)
Get a list of the registered suspend event listeners with the given type
-
-
-
-