com.flyingspaniel.nava.emit

Class EmitListenerList<A0>

java.lang.Object

com.flyingspaniel.nava.emit.EmitListenerList<A0>

Type Parameters:

A0 - the class of the first argument sent to the listener

All Implemented Interfaces:

Emit.IListenerList<A0>

public class EmitListenerList<A0>
extends Object
implements Emit.IListenerList<A0>

A semi-replacement for EventListenerList, inspired by node.js Emitters.
This handles emitting events for one particular ID (e.g. "error") of listener.

Uses a CopyOnWriteArrayList. Order of addition is preserved. You can generally NOT add a listener twice - see allowDuplicates

Normally clients don't use this directly, they use Emitter which fires multiple event types

Since:

Copyright(c) 2013 Morgan Conrad

Author:

Morgan Conrad

See Also:

This software is released under the MIT License

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowDuplicates
protected Collection<Emit.IListener<A0>>	listeners
protected Collection<Emit.IListener<A0>>	onces

Constructor Summary

Constructors

Constructor and Description
EmitListenerList(boolean allowDuplicates) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Emit.IListener<A0> listener)
protected Collection<Emit.IListener<A0>>	createCollection() This is a good implementation, but subclasses might want to override...
boolean	emit(A0 arg0, Object... more) Fires the event/object
int	listenerCount() Current number of listeners
Collection<Emit.IListener<A0>>	listeners() Returns the raw listeners, use with extreme caution
void	on(Emit.IListener<A0> listener) Add a listener
void	once(Emit.IListener<A0> listener) Add a listener that will be triggered only once
void	removeAllListeners() Remove all listeners
void	removeListener(Emit.IListener<A0> listener) Remove the listener, from onces and listeners

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected Collection<Emit.IListener<A0>> listeners

onces

protected Collection<Emit.IListener<A0>> onces

allowDuplicates

protected boolean allowDuplicates

Constructor Detail

EmitListenerList

public EmitListenerList(boolean allowDuplicates)

Constructor

Parameters:

allowDuplicates -

Method Detail

on

public void on(Emit.IListener<A0> listener)

Add a listener

Specified by:

on in interface Emit.IListenerList<A0>

Parameters:

listener - if null nothing happens.

addListener

public void addListener(Emit.IListener<A0> listener)

Specified by:

addListener in interface Emit.IListenerList<A0>

once

public void once(Emit.IListener<A0> listener)

Add a listener that will be triggered only once

Specified by:

once in interface Emit.IListenerList<A0>

Parameters:

listener - if null nothing happens.

removeListener

public void removeListener(Emit.IListener<A0> listener)

Remove the listener, from onces and listeners

Specified by:

removeListener in interface Emit.IListenerList<A0>

Parameters:

listener - if null nothing happens. They expect an as their first arg to the callback

removeAllListeners

public void removeAllListeners()

Remove all listeners

Specified by:

removeAllListeners in interface Emit.IListenerList<A0>

emit

public boolean emit(A0 arg0,
           Object... more)

Fires the event/object

Specified by:

emit in interface Emit.IListenerList<A0>

Parameters:

arg0 - hopefully an

more - may be an empty array

listenerCount

public int listenerCount()

Current number of listeners

Specified by:

listenerCount in interface Emit.IListenerList<A0>

listeners

public Collection<Emit.IListener<A0>> listeners()

Returns the raw listeners, use with extreme caution

Specified by:

listeners in interface Emit.IListenerList<A0>

createCollection

protected Collection<Emit.IListener<A0>> createCollection()

This is a good implementation, but subclasses might want to override...

Returns:

a thread-safe Collection