org.botlibre.sense

Class BasicTool

java.lang.Object

org.botlibre.sense.BasicTool

All Implemented Interfaces:

Tool

Direct Known Subclasses:

Calculator, Date, JSON, Math, Utils, Watch

public class BasicTool
extends java.lang.Object
implements Tool

Defines an external interface. i.e. - calculator - watch

Constructor Summary

Constructors

Constructor and Description
BasicTool()

Method Summary

Modifier and Type	Method and Description
void	addListener(ExceptionEventListener listener) Add the exception listener.
void	awake() Start sensing.
Bot	getBot() Return the associated Bot instance.
java.util.List<ExceptionEventListener>	getListeners()
java.lang.String	getName() Return the name that identifies the sense.
Primitive	getPrimitive() Allows senses to be referenced by memory.
Network	getShortTermMemory() Return the short term memory.
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configurable settings from the properties.
boolean	isEnabled() Return if the sense is enabled.
void	log(java.lang.String message, java.util.logging.Level level) Log the message if the debug level is greater or equal to the level.
void	log(java.lang.String message, java.util.logging.Level level, java.lang.Object... arguments) Log the message if the debug level is greater or equal to the level.
void	log(java.lang.Throwable error) Log the exception.
void	notifyExceptionListeners(java.lang.Exception exception)
void	pool() Reset state when instance is pooled.
void	removeListener(ExceptionEventListener listener)
void	setBot(Bot Bot) Set the associated Bot instance.
void	setIsEnabled(boolean isEnabled) Allow the sense to disabled/enabled.
void	setName(java.lang.String name) Set the name that identifies the sense.
void	shutdown() Stop sensing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicTool

public BasicTool()

Method Detail

isEnabled

public boolean isEnabled()

Return if the sense is enabled.

Specified by:

isEnabled in interface Tool

setIsEnabled

public void setIsEnabled(boolean isEnabled)

Allow the sense to disabled/enabled.

Specified by:

setIsEnabled in interface Tool

awake

public void awake()

Start sensing.

Specified by:

awake in interface Tool

shutdown

public void shutdown()

Stop sensing.

Specified by:

shutdown in interface Tool

pool

public void pool()

Reset state when instance is pooled.

Specified by:

pool in interface Tool

getName

public java.lang.String getName()

Return the name that identifies the sense.

Specified by:

getName in interface Tool

setName

public void setName(java.lang.String name)

Set the name that identifies the sense.

Specified by:

setName in interface Tool

getShortTermMemory

public Network getShortTermMemory()

Return the short term memory.

log

public void log(java.lang.String message,
                java.util.logging.Level level,
                java.lang.Object... arguments)

Log the message if the debug level is greater or equal to the level.

log

public void log(java.lang.String message,
                java.util.logging.Level level)

Log the message if the debug level is greater or equal to the level.

log

public void log(java.lang.Throwable error)

Log the exception.

getPrimitive

public Primitive getPrimitive()

Description copied from interface: Tool

Allows senses to be referenced by memory.

Specified by:

getPrimitive in interface Tool

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBot

public Bot getBot()

Return the associated Bot instance.

Specified by:

getBot in interface Tool

setBot

public void setBot(Bot Bot)

Set the associated Bot instance.

Specified by:

setBot in interface Tool

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.Object> properties)

Initialize any configurable settings from the properties.

Specified by:

initialize in interface Tool

notifyExceptionListeners

public void notifyExceptionListeners(java.lang.Exception exception)

Specified by:

notifyExceptionListeners in interface Tool

getListeners

public java.util.List<ExceptionEventListener> getListeners()

addListener

public void addListener(ExceptionEventListener listener)

Add the exception listener. It will be notified of any exceptions.

removeListener

public void removeListener(ExceptionEventListener listener)