com.flyingspaniel.nava.emit

Interface Emit.IEmitter

All Known Implementing Classes:

Emitter, EmittingCallbackFn, EmittingCallbackFn.NOP, Request

Enclosing class:

Emit

public static interface Emit.IEmitter

Interface for objects that can emit/broadcast "events" of various eventIDs

In node.js the eventIDs are Strings, e.g 'error'. We allow anything. Strings are probably simplest, but Classes and Enums also make sense.

Author:

Morgan Conrad Copyright(c) 2013 Morgan Conrad

Method Summary

Methods

Modifier and Type	Method and Description
<A0> Emit.IEmitter	addListener(Object eventID, Emit.IListener<A0> listener) Add a listener for the specific eventID
<A0> boolean	emit(Object eventID, A0 arg0) Convenience method, fire the event to all listeners for that eventID, with more = empty array
<A0> boolean	emit(Object eventID, A0 arg0, Object... more) Fire the event to all listeners for that eventID
<A0> boolean	fireEvent(Object eventID, A0 arg0, Object... more) Same as emit, convenience method
int	listenerCount(Object eventID) Counts all listeners for a given event (same as listeners(eventID).size())
<A0> Collection<Emit.IListener<A0>>	listeners(Object eventID) Return a shallow copy of listeners for a given eventID
<A0> Emit.IEmitter	on(Object eventID, Emit.IListener<A0> listener) Syntactic sugar, same as addListener()
<A0> Emit.IEmitter	once(Object eventID, Emit.IListener<A0> listener) Add a listener that will only receive one event, then get disconnected
<A0> Emit.IEmitter	removeAllListeners(Object eventID) Remove all listeners for the specified eventID
<A0> Emit.IEmitter	removeListener(Object eventID, Emit.IListener<A0> listener) Remove a listener for the specific eventID
Emitter	setMaxListeners(int max) Sets the maximum listeners for each eventID.

Method Detail

addListener

<A0> Emit.IEmitter addListener(Object eventID,
                             Emit.IListener<A0> listener)

Add a listener for the specific eventID

Parameters:

eventID - non-null

listener - if null nothing happens

Returns:

this (for chaining)

on

<A0> Emit.IEmitter on(Object eventID,
                    Emit.IListener<A0> listener)

Syntactic sugar, same as addListener()

Parameters:

eventID - non-null

listener -

Returns:

this (for chaining)

once

<A0> Emit.IEmitter once(Object eventID,
                      Emit.IListener<A0> listener)

Add a listener that will only receive one event, then get disconnected

Parameters:

eventID - non-null

listener - if null nothing happens

Returns:

this (for chaining)

removeListener

<A0> Emit.IEmitter removeListener(Object eventID,
                                Emit.IListener<A0> listener)

Remove a listener for the specific eventID

Parameters:

eventID - non-null

listener - if null nothing happens

Returns:

this (for chaining)

removeAllListeners

<A0> Emit.IEmitter removeAllListeners(Object eventID)

Remove all listeners for the specified eventID

Parameters:

eventID - if null, all listeners of all eventIDs are removed

Returns:

this (for chaining)

emit

<A0> boolean emit(Object eventID,
                A0 arg0,
                Object... more)

Fire the event to all listeners for that eventID

Parameters:

eventID - non-null

arg0 - 1st arg to listener

more - more args

Returns:

true if event had listeners

emit

<A0> boolean emit(Object eventID,
                A0 arg0)

Convenience method, fire the event to all listeners for that eventID, with more = empty array

Parameters:

eventID - non-null

arg0 - 1st arg to listener

Returns:

true if event had listeners

fireEvent

<A0> boolean fireEvent(Object eventID,
                     A0 arg0,
                     Object... more)

Same as emit, convenience method

Parameters:

eventID -

arg0 -

more -

Returns:

true if event had listeners

listeners

<A0> Collection<Emit.IListener<A0>> listeners(Object eventID)

Return a shallow copy of listeners for a given eventID

Parameters:

eventID - if null, collects ALL listeners

Returns:

Collection, non-null, may be empty if there are none

listenerCount

int listenerCount(Object eventID)

Counts all listeners for a given event (same as listeners(eventID).size())

Parameters:

eventID - if null, counts ALL listeners

Returns:

integer count

setMaxListeners

Emitter setMaxListeners(int max)

Sets the maximum listeners for each eventID. Default = 10

Parameters:

max - 0 means unlimited. Use -1 to allow no listeners at all

Returns:

this