won.bot.framework.eventbot.listener

Class BaseEventListener

java.lang.Object

won.bot.framework.eventbot.listener.BaseEventListener

All Implemented Interfaces:

EventListener

Direct Known Subclasses:

AbstractDoOnceAfterNEventsListener, AbstractFinishingListener, AbstractHandleFirstNEventsListener, ActionOnEventListener, AutomaticBAMessageResponderListener, DefaultEventListener, PublishEventAfterNEventsListener

public abstract class BaseEventListener
extends java.lang.Object
implements EventListener

Base class for event listeners

Field Summary

Fields

Modifier and Type	Field and Description
protected EventFilter	eventFilter
protected org.slf4j.Logger	logger
protected java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	countThrowable(java.lang.Throwable e)
protected abstract void	doOnEvent(Event event)
int	getEventCount()
protected EventListenerContext	getEventListenerContext()
int	getExceptionCount()
long	getMillisExecuting()
boolean	isUnsubscribeOnException()
void	onEvent(Event event)
protected void	publishFinishedEvent() Publishes an event indicating that the listener is finished.
void	setUnsubscribeOnException(boolean unsubscribeOnException)
protected boolean	shouldHandleEvent(Event event) Determines whether the given event should be processed or ignored.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

eventFilter

protected EventFilter eventFilter

name

protected java.lang.String name

Constructor Detail

BaseEventListener

protected BaseEventListener(EventListenerContext context)

BaseEventListener

protected BaseEventListener(EventListenerContext context,
                            EventFilter eventFilter)

BaseEventListener

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

BaseEventListener

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

Method Detail

onEvent

public final void onEvent(Event event)
                   throws java.lang.Exception

Specified by:

onEvent in interface EventListener

Throws:

java.lang.Exception

publishFinishedEvent

protected void publishFinishedEvent()

Publishes an event indicating that the listener is finished. Useful for chaining listeners. Only use when this is really the case.

getMillisExecuting

public long getMillisExecuting()

getExceptionCount

public int getExceptionCount()

getEventCount

public int getEventCount()

isUnsubscribeOnException

public boolean isUnsubscribeOnException()

setUnsubscribeOnException

public void setUnsubscribeOnException(boolean unsubscribeOnException)

countThrowable

protected void countThrowable(java.lang.Throwable e)

doOnEvent

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

Throws:

java.lang.Exception

getEventListenerContext

protected EventListenerContext getEventListenerContext()

shouldHandleEvent

protected final boolean shouldHandleEvent(Event event)

Determines whether the given event should be processed or ignored. If it is ignored, it is not counted and does not influence the listener's behavior. The default implementation accepts all events.

Parameters:

event -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object