won.bot.framework.eventbot.listener

Class AbstractFinishingListener

java.lang.Object

won.bot.framework.eventbot.listener.BaseEventListener

won.bot.framework.eventbot.listener.AbstractFinishingListener

All Implemented Interfaces:

EventListener, FinishingListener

Direct Known Subclasses:

BATestScriptListener

public abstract class AbstractFinishingListener
extends BaseEventListener
implements FinishingListener

Base class for listeners that eventually stop listening. When the decision is made to finish, a FinishedEvent is published and the listener is unsubscribed from all further events.

Field Summary

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

eventFilter, logger, name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	doOnEvent(Event event)
protected abstract void	handleEvent(Event event)
abstract boolean	isFinished()
protected void	performFinish() Performs all finishing actions and sets the finished flag
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

AbstractFinishingListener

protected AbstractFinishingListener(EventListenerContext context)

AbstractFinishingListener

protected AbstractFinishingListener(EventListenerContext context,
                                    EventFilter eventFilter)

AbstractFinishingListener

protected AbstractFinishingListener(EventListenerContext context,
                                    java.lang.String name)

AbstractFinishingListener

protected AbstractFinishingListener(EventListenerContext context,
                                    java.lang.String name,
                                    EventFilter eventFilter)

Method Detail

doOnEvent

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

Specified by:

doOnEvent in class BaseEventListener

Throws:

java.lang.Exception

performFinish

protected void performFinish()

Performs all finishing actions and sets the finished flag

unsubscribe

protected abstract void unsubscribe()

handleEvent

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

Throws:

java.lang.Exception

isFinished

public abstract boolean isFinished()

Specified by:

isFinished in interface FinishingListener

toString

public java.lang.String toString()

Overrides:

toString in class BaseEventListener