won.bot.framework.eventbot.behaviour

Class BotBehaviour

java.lang.Object

won.bot.framework.eventbot.behaviour.BotBehaviour

Direct Known Subclasses:

AnalyzeBehaviour, BehaviourBarrier, CloseBevahiour, ConnectBehaviour, ConnectionMessageBehaviour, CoordinationBehaviour, CrawlConnectionDataBehaviour, DeactivateNeedBehaviour, EagerlyPopulateCacheBehaviour, ExecuteWonMessageCommandBehaviour, FactoryBotHintBehaviour, FactoryBotInitBehaviour

public abstract class BotBehaviour
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<EventListener>	activeListeners
protected EventListenerContext	context
protected java.util.Set<CoordinationBehaviour>	coordinationBehaviours
protected org.slf4j.Logger	logger
protected java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
BotBehaviour(EventListenerContext context)
BotBehaviour(EventListenerContext context, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the behaviour without passing a message object.
void	activate(java.util.Optional<java.lang.Object> message) Activates the behaviour by registering listeners.
void	deactivate() Deactivates the behaviour without passing a message.
void	deactivate(java.util.Optional<java.lang.Object> message) Deactivates the behaviour.
java.lang.String	getName()
boolean	isActive()
protected abstract void	onActivate(java.util.Optional<java.lang.Object> message) Activates the behaviour by registering listeners, if you addListeners with the subscribeWithAutoCleanup method, you do not have to clean them within the onCleanup method.
void	onActivateActivate(BotBehaviour... nextBehaviours)
void	onActivateDeactivate(BotBehaviour... nextBehaviours)
protected void	onCleanup() Deactivates the behaviour.
void	onDeactivateActivate(BotBehaviour... nextBehaviours)
void	onDeactivateDeactivate(BotBehaviour... nextBehaviours)
protected <T extends Event> void	subscribeWithAutoCleanup(java.lang.Class<T> eventClazz, EventListener listener) Subscribes an Event/EventListener Pair, that will be automatically cleaned within the deactivate process of this behaviour.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

name

protected final java.lang.String name

context

protected final EventListenerContext context

activeListeners

protected java.util.Set<EventListener> activeListeners

coordinationBehaviours

protected java.util.Set<CoordinationBehaviour> coordinationBehaviours

Constructor Detail

BotBehaviour

public BotBehaviour(EventListenerContext context)

BotBehaviour

public BotBehaviour(EventListenerContext context,
                    java.lang.String name)

Method Detail

onDeactivateActivate

public void onDeactivateActivate(BotBehaviour... nextBehaviours)

onActivateActivate

public void onActivateActivate(BotBehaviour... nextBehaviours)

onDeactivateDeactivate

public void onDeactivateDeactivate(BotBehaviour... nextBehaviours)

onActivateDeactivate

public void onActivateDeactivate(BotBehaviour... nextBehaviours)

activate

public final void activate()

Activates the behaviour without passing a message object.

activate

public final void activate(java.util.Optional<java.lang.Object> message)

Activates the behaviour by registering listeners. If the onActivate method of the subclass throws an Exception, the deactivate method is called. The specified optional message is passed to subclasses.

deactivate

public final void deactivate()

Deactivates the behaviour without passing a message.

deactivate

public final void deactivate(java.util.Optional<java.lang.Object> message)

Deactivates the behaviour. Automatically unsubscribes every EventListener Instance that has been created. No traces of it must be left in the Event Bus after this method has finished. The specified optional message is passed to subclasses.

subscribeWithAutoCleanup

protected <T extends Event> void subscribeWithAutoCleanup(java.lang.Class<T> eventClazz,
                                                          EventListener listener)

Subscribes an Event/EventListener Pair, that will be automatically cleaned within the deactivate process of this behaviour.

onCleanup

protected void onCleanup()

Deactivates the behaviour. No traces of it must be left in the Event Bus after this method has finished. No Implementation required if EventListeners are added with the subscribeWithAutoCleanup method.

onActivate

protected abstract void onActivate(java.util.Optional<java.lang.Object> message)

Activates the behaviour by registering listeners, if you addListeners with the subscribeWithAutoCleanup method, you do not have to clean them within the onCleanup method.

getName

public java.lang.String getName()

isActive

public boolean isActive()