won.bot.framework.eventbot.listener

Class AbstractDoOnceAfterNEventsListener

java.lang.Object

won.bot.framework.eventbot.listener.BaseEventListener

won.bot.framework.eventbot.listener.AbstractDoOnceAfterNEventsListener

All Implemented Interfaces:

CountingListener, EventListener, FinishingListener

Direct Known Subclasses:

ActionOnceAfterNEventsListener, WaitForNEventsListener

public abstract class AbstractDoOnceAfterNEventsListener
extends BaseEventListener
implements CountingListener

Counts how often it is called, offers to call a callback when a certain number is reached. After the target count of events is reached, a FinishedEvent is published. This allows for chaining listeners.

Field Summary

Fields inherited from class won.bot.framework.eventbot.listener.BaseEventListener

eventFilter, logger, name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDoOnceAfterNEventsListener(EventListenerContext context, EventFilter eventFilter, int targetCount)
	AbstractDoOnceAfterNEventsListener(EventListenerContext context, int targetCount)
protected	AbstractDoOnceAfterNEventsListener(EventListenerContext context, java.lang.String name, EventFilter eventFilter, int targetCount)
protected	AbstractDoOnceAfterNEventsListener(EventListenerContext context, java.lang.String name, int targetCount)

Method Summary

Modifier and Type	Method and Description
protected abstract void	doOnce(Event event)
void	doOnEvent(Event event)
int	getCount()
int	getTargetCount()
boolean	isFinished()
java.lang.String	toString()
protected abstract void	unsubscribe()

Methods inherited from class won.bot.framework.eventbot.listener.BaseEventListener

countThrowable, getEventCount, getEventListenerContext, getExceptionCount, getMillisExecuting, isUnsubscribeOnException, onEvent, publishFinishedEvent, setUnsubscribeOnException, shouldHandleEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface won.bot.framework.eventbot.listener.EventListener

onEvent

Constructor Detail

AbstractDoOnceAfterNEventsListener

public AbstractDoOnceAfterNEventsListener(EventListenerContext context,
                                          int targetCount)

AbstractDoOnceAfterNEventsListener

protected AbstractDoOnceAfterNEventsListener(EventListenerContext context,
                                             EventFilter eventFilter,
                                             int targetCount)

AbstractDoOnceAfterNEventsListener

protected AbstractDoOnceAfterNEventsListener(EventListenerContext context,
                                             java.lang.String name,
                                             int targetCount)

AbstractDoOnceAfterNEventsListener

protected AbstractDoOnceAfterNEventsListener(EventListenerContext context,
                                             java.lang.String name,
                                             EventFilter eventFilter,
                                             int targetCount)

Method Detail

doOnEvent

public void doOnEvent(Event event)
               throws java.lang.Exception

Specified by:

doOnEvent in class BaseEventListener

Throws:

java.lang.Exception

unsubscribe

protected abstract void unsubscribe()

doOnce

protected abstract void doOnce(Event event)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getTargetCount

public int getTargetCount()

Specified by:

getTargetCount in interface CountingListener

getCount

public int getCount()

Specified by:

getCount in interface CountingListener

isFinished

public boolean isFinished()

Specified by:

isFinished in interface FinishingListener

toString

public java.lang.String toString()

Overrides:

toString in class BaseEventListener