org.botlibre.api.sense

Interface Tool

All Known Implementing Classes:

BasicTool, Calculator, Date, JSON, Math, Utils, Watch

public interface Tool

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

Method Summary

Modifier and Type	Method and Description
void	awake() Start.
Bot	getBot() Return the associated Bot instance.
java.lang.String	getName() Return the name that identifies the tool.
Primitive	getPrimitive() Allows senses to be referenced by memory.
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configuration properties.
boolean	isEnabled() Return if the sense is enabled.
void	notifyExceptionListeners(java.lang.Exception exception)
void	pool() Reset state when instance is pooled.
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 tool.
void	shutdown() Stop.

Method Detail

initialize

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

Initialize any configuration properties.

awake

void awake()

Start.

shutdown

void shutdown()

Stop.

pool

void pool()

Reset state when instance is pooled.

getName

java.lang.String getName()

Return the name that identifies the tool.

setName

void setName(java.lang.String name)

Set the name that identifies the tool.

getBot

Bot getBot()

Return the associated Bot instance.

setBot

void setBot(Bot Bot)

Set the associated Bot instance.

isEnabled

boolean isEnabled()

Return if the sense is enabled.

setIsEnabled

void setIsEnabled(boolean isEnabled)

Allow the sense to disabled/enabled.

getPrimitive

Primitive getPrimitive()

Allows senses to be referenced by memory.

notifyExceptionListeners

void notifyExceptionListeners(java.lang.Exception exception)