org.botlibre

Class Bot

java.lang.Object

org.botlibre.Bot

public class Bot
extends java.lang.Object

This class represents the identity of a bot, and controls module registration, startup and shutdown. It defines a singleton that represents the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Bot.ActiveState

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_FILE
static java.util.logging.Level	DEFAULT_DEBUG_LEVEL
static java.util.logging.Level	FINE
static java.util.logging.Level[]	LEVELS
static int	MAX_CACHE
static int	MIN_CACHE
Bot	parent
static int	POOL_SIZE
static java.lang.String	PROGRAM
static Bot	systemCache
static java.lang.String	VERSION
static java.util.logging.Level	WARNING

Constructor Summary

Constructors

Constructor and Description
Bot()

Method Summary

Modifier and Type	Method and Description
void	addLogListener(LogListener listener)
Avatar	avatar() Return the Avatar.
Awareness	awareness() Return the awareness.
static void	clearPool()
static Bot	createInstance()
static Bot	createInstance(java.lang.String configFile, java.lang.String memory, boolean isSchema)
static Bot	createInstanceFromPool(java.lang.String instanceName, boolean isSchema) Return the cached instance from the pool if available, otherwise create a new instance.
static Bot	fastCreateInstance(java.lang.String configFile, java.lang.String memory, boolean isSchema)
static void	forceShutdown(java.lang.String name) Shutdown the pooled instance.
java.lang.String	fullToString()
java.util.logging.Level	getDebugLevel() Return the debugging level.
boolean	getFilterProfanity()
static java.util.concurrent.ConcurrentMap<java.lang.String,Bot>	getInstances()
java.util.logging.Logger	getLog()
java.util.Set<LogListener>	getLogListeners()
java.lang.String	getName() Return the instance's name.
Bot	getParent()
Bot.ActiveState	getState()
Stats	getStats()
static Bot	getSystemCache()
boolean	isDebug()
boolean	isDebugFine()
boolean	isDebugFiner()
boolean	isDebugFinest()
boolean	isDebugSever()
boolean	isDebugWarning()
void	log(java.lang.Object source, 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.Object source, java.lang.Throwable error) Log the exception.
Memory	memory() Return the memory.
Mind	mind() Return the mind.
Mood	mood() Return the mood.
void	pool() Return the instance to the pool, or shutdown if too many instances pooled.
void	removeLogListener(LogListener listener)
void	setAvatar(Avatar avatar) Set the Avatar.
void	setAwareness(Awareness awareness) Set the awareness.
void	setDebugLevel(java.util.logging.Level level) Set the debugging level.
void	setFilterProfanity(boolean filterProfanity)
void	setLog(java.util.logging.Logger log)
void	setLogListeners(java.util.Set<LogListener> logListeners)
void	setMemory(Memory memory) Set the memory.
void	setMind(Mind mind) Set the mind.
void	setMood(Mood mood) Set the mood.
void	setName(java.lang.String name) Set the instance's name.
void	setParent(Bot parent)
void	setState(Bot.ActiveState state)
void	setStats(Stats stats)
static void	setSystemCache(Bot systemCache)
void	shutdown() Shutdown the system gracefully, persist memory and terminate thoughts.
void	stat(java.lang.String stat) Raise the statistic event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PROGRAM

public static java.lang.String PROGRAM

VERSION

public static java.lang.String VERSION

FINE

public static final java.util.logging.Level FINE

WARNING

public static final java.util.logging.Level WARNING

DEFAULT_DEBUG_LEVEL

public static java.util.logging.Level DEFAULT_DEBUG_LEVEL

LEVELS

public static final java.util.logging.Level[] LEVELS

CONFIG_FILE

public static java.lang.String CONFIG_FILE

MAX_CACHE

public static int MAX_CACHE

MIN_CACHE

public static int MIN_CACHE

POOL_SIZE

public static int POOL_SIZE

systemCache

public static Bot systemCache

parent

public Bot parent

Constructor Detail

Bot

public Bot()

Method Detail

getSystemCache

public static Bot getSystemCache()

setSystemCache

public static void setSystemCache(Bot systemCache)

createInstance

public static Bot createInstance()

createInstance

public static Bot createInstance(java.lang.String configFile,
                                 java.lang.String memory,
                                 boolean isSchema)

fastCreateInstance

public static Bot fastCreateInstance(java.lang.String configFile,
                                     java.lang.String memory,
                                     boolean isSchema)

createInstanceFromPool

public static Bot createInstanceFromPool(java.lang.String instanceName,
                                         boolean isSchema)

Return the cached instance from the pool if available, otherwise create a new instance.

stat

public void stat(java.lang.String stat)

Raise the statistic event.

getStats

public Stats getStats()

setStats

public void setStats(Stats stats)

getState

public Bot.ActiveState getState()

setState

public void setState(Bot.ActiveState state)

getParent

public Bot getParent()

setParent

public void setParent(Bot parent)

getFilterProfanity

public boolean getFilterProfanity()

setFilterProfanity

public void setFilterProfanity(boolean filterProfanity)

getDebugLevel

public java.util.logging.Level getDebugLevel()

Return the debugging level.

isDebug

public boolean isDebug()

isDebugFine

public boolean isDebugFine()

isDebugFiner

public boolean isDebugFiner()

isDebugFinest

public boolean isDebugFinest()

isDebugWarning

public boolean isDebugWarning()

isDebugSever

public boolean isDebugSever()

log

public void log(java.lang.Object source,
                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.Object source,
                java.lang.Throwable error)

Log the exception.

setDebugLevel

public void setDebugLevel(java.util.logging.Level level)

Set the debugging level.

awareness

public Awareness awareness()

Return the awareness. The awareness defines the senses.

setAwareness

public void setAwareness(Awareness awareness)

Set the awareness. The awareness defines the senses.

mind

public Mind mind()

Return the mind. The mind defines the thoughts.

mood

public Mood mood()

Return the mood. The mood defines emotional states.

avatar

public Avatar avatar()

Return the Avatar. The Avatar expresses the emotional states.

setMind

public void setMind(Mind mind)

Set the mind. The mind defines the thoughts.

setMood

public void setMood(Mood mood)

Set the mood. The mood defines emotional states.

setAvatar

public void setAvatar(Avatar avatar)

Set the Avatar. The Avatar expresses the emotional state.

memory

public Memory memory()

Return the memory. The memory defines the knowledge networks.

setMemory

public void setMemory(Memory memory)

Set the memory. The memory defines the knowledge networks.

shutdown

public void shutdown()

Shutdown the system gracefully, persist memory and terminate thoughts.

forceShutdown

public static void forceShutdown(java.lang.String name)

Shutdown the pooled instance.

clearPool

public static void clearPool()

pool

public void pool()

Return the instance to the pool, or shutdown if too many instances pooled.

getName

public java.lang.String getName()

Return the instance's name. This is the real name, but defaults to the database name.

setName

public void setName(java.lang.String name)

Set the instance's name. This is the real name, but defaults to the database name.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fullToString

public java.lang.String fullToString()

addLogListener

public void addLogListener(LogListener listener)

removeLogListener

public void removeLogListener(LogListener listener)

getLogListeners

public java.util.Set<LogListener> getLogListeners()

setLogListeners

public void setLogListeners(java.util.Set<LogListener> logListeners)

getInstances

public static java.util.concurrent.ConcurrentMap<java.lang.String,Bot> getInstances()

getLog

public java.util.logging.Logger getLog()

setLog

public void setLog(java.util.logging.Logger log)