unsw.cse.mica.util
Interface MicaConstants

All Known Implementing Classes:
DefaultBlackboard, Mob, SimpleBlackboard, SQLBlackboard

public interface MicaConstants

This class holds special constants that are used throughout Mica for common Mob field names or return values; also common initialisation keys and default values.

Author:
Mark Reid

Field Summary
static java.lang.String DEFAULT_DB_PATH
          The default path and prefix for blackboard database files
static java.lang.String DEFAULT_HOST
          The default TCP host for agent connections
static java.lang.String DEFAULT_MICA_HOME
          The default mica home directory
static java.lang.String DEFAULT_PERSISTENCE
          A value giving the default persistence for mobs that have no persistence explicitly specified.
static boolean DEFAULT_PERSISTENT
          the default persistence setting for blackboards
static int DEFAULT_PORT
          The default TCP port for TCP connections
static java.lang.String DEFAULT_TYPE_PATH
          The default path to the mob type configuration files
static java.lang.String[] INTERNAL_SLOT_NAMES
          An array containing all the mob slot names that are used internally by mica.
static java.lang.String PARAM_DB_PATH
          The default parameter name for specifying the relative path and prefix for blackboard database files
static java.lang.String PARAM_DEBUG
          The default parameter name for specifying a debug level
static java.lang.String PARAM_HOST
          The default parameter name for passing TCP host information
static java.lang.String PARAM_MICA_HOME
          The default parameter name for specifying the mica home directory
static java.lang.String PARAM_PERSISTENT
          The default parameter name for specifying blackboard persistence
static java.lang.String PARAM_PORT
          The default parameter name for passing TCP port information
static java.lang.String PARAM_TYPE_PATH
          The default parameter name for specifying the relative path to the mob type configuration files
static java.lang.String PERSISTENCE_CONNECTED
          A value indicating that the mob's persistence is connection-based - it is to be deleted when its owner (i.e.
static java.lang.String PERSISTENCE_PERMANENT
          A persistence value indicating that the mob is permanent - It is to be stored until explicitly deleted.
static java.lang.String PERSISTENCE_TRANSIENT
          A value indicating that the mob is transient - it is not to be stored at all on the blackboard
static java.lang.String[] PERSISTENCES
          An array containing all legal persistence values
static java.lang.String RESULT_ERROR
          the response string sent bt the blackboard when an unspecified error occurred
static java.lang.String RESULT_NOSUCHAGENT
          The reponse string sent by the blackboard when a non-existent agent name is used
static java.lang.String RESULT_NOSUCHMOB
          The reponse string sent by the blackboard when a non-existent mob is requested
static java.lang.String RESULT_SUCCESS
          The reponse string sent by the blackboard when an action succeeds
static java.lang.String SLOT_CREATIONTIME
          The slotname used by MICA to store a mob's creation time
static java.lang.String SLOT_CREATOR
          The slotname used by MICA to store a mob's creator
static java.lang.String SLOT_DELETER
          The slotname used by MICA to store a mob's deleter
static java.lang.String SLOT_DELETIONTIME
          The slotname used by MICA to store a mob's deletion time
static java.lang.String SLOT_MODIFICATIONTIME
          The slotname used by MICA to store a mob's deletion time
static java.lang.String SLOT_MODIFIER
          The slotname used by MICA to store a mob's deleter
static java.lang.String UNKNOWN_AGENT
          Used internally for testing when an agent's name is null
 

Field Detail

PARAM_HOST

static final java.lang.String PARAM_HOST
The default parameter name for passing TCP host information

See Also:
Constant Field Values

PARAM_PORT

static final java.lang.String PARAM_PORT
The default parameter name for passing TCP port information

See Also:
Constant Field Values

PARAM_MICA_HOME

static final java.lang.String PARAM_MICA_HOME
The default parameter name for specifying the mica home directory

See Also:
Constant Field Values

PARAM_TYPE_PATH

static final java.lang.String PARAM_TYPE_PATH
The default parameter name for specifying the relative path to the mob type configuration files

See Also:
Constant Field Values

PARAM_DB_PATH

static final java.lang.String PARAM_DB_PATH
The default parameter name for specifying the relative path and prefix for blackboard database files

See Also:
Constant Field Values

PARAM_PERSISTENT

static final java.lang.String PARAM_PERSISTENT
The default parameter name for specifying blackboard persistence

See Also:
Constant Field Values

PARAM_DEBUG

static final java.lang.String PARAM_DEBUG
The default parameter name for specifying a debug level

See Also:
Constant Field Values

DEFAULT_MICA_HOME

static final java.lang.String DEFAULT_MICA_HOME
The default mica home directory

See Also:
Constant Field Values

DEFAULT_TYPE_PATH

static final java.lang.String DEFAULT_TYPE_PATH
The default path to the mob type configuration files

See Also:
Constant Field Values

DEFAULT_PERSISTENT

static final boolean DEFAULT_PERSISTENT
the default persistence setting for blackboards

See Also:
Constant Field Values

DEFAULT_DB_PATH

static final java.lang.String DEFAULT_DB_PATH
The default path and prefix for blackboard database files

See Also:
Constant Field Values

DEFAULT_HOST

static final java.lang.String DEFAULT_HOST
The default TCP host for agent connections

See Also:
Constant Field Values

DEFAULT_PORT

static final int DEFAULT_PORT
The default TCP port for TCP connections

See Also:
Constant Field Values

UNKNOWN_AGENT

static final java.lang.String UNKNOWN_AGENT
Used internally for testing when an agent's name is null

See Also:
Constant Field Values

RESULT_SUCCESS

static final java.lang.String RESULT_SUCCESS
The reponse string sent by the blackboard when an action succeeds

See Also:
Constant Field Values

RESULT_NOSUCHMOB

static final java.lang.String RESULT_NOSUCHMOB
The reponse string sent by the blackboard when a non-existent mob is requested

See Also:
Constant Field Values

RESULT_NOSUCHAGENT

static final java.lang.String RESULT_NOSUCHAGENT
The reponse string sent by the blackboard when a non-existent agent name is used

See Also:
Constant Field Values

RESULT_ERROR

static final java.lang.String RESULT_ERROR
the response string sent bt the blackboard when an unspecified error occurred

See Also:
Constant Field Values

SLOT_CREATIONTIME

static final java.lang.String SLOT_CREATIONTIME
The slotname used by MICA to store a mob's creation time

See Also:
Constant Field Values

SLOT_CREATOR

static final java.lang.String SLOT_CREATOR
The slotname used by MICA to store a mob's creator

See Also:
Constant Field Values

SLOT_MODIFICATIONTIME

static final java.lang.String SLOT_MODIFICATIONTIME
The slotname used by MICA to store a mob's deletion time

See Also:
Constant Field Values

SLOT_MODIFIER

static final java.lang.String SLOT_MODIFIER
The slotname used by MICA to store a mob's deleter

See Also:
Constant Field Values

SLOT_DELETIONTIME

static final java.lang.String SLOT_DELETIONTIME
The slotname used by MICA to store a mob's deletion time

See Also:
Constant Field Values

SLOT_DELETER

static final java.lang.String SLOT_DELETER
The slotname used by MICA to store a mob's deleter

See Also:
Constant Field Values

INTERNAL_SLOT_NAMES

static final java.lang.String[] INTERNAL_SLOT_NAMES
An array containing all the mob slot names that are used internally by mica.


PERSISTENCE_TRANSIENT

static final java.lang.String PERSISTENCE_TRANSIENT
A value indicating that the mob is transient - it is not to be stored at all on the blackboard

See Also:
Constant Field Values

PERSISTENCE_CONNECTED

static final java.lang.String PERSISTENCE_CONNECTED
A value indicating that the mob's persistence is connection-based - it is to be deleted when its owner (i.e. the creator) disconnects

See Also:
Constant Field Values

PERSISTENCE_PERMANENT

static final java.lang.String PERSISTENCE_PERMANENT
A persistence value indicating that the mob is permanent - It is to be stored until explicitly deleted.

See Also:
Constant Field Values

DEFAULT_PERSISTENCE

static final java.lang.String DEFAULT_PERSISTENCE
A value giving the default persistence for mobs that have no persistence explicitly specified.

See Also:
Constant Field Values

PERSISTENCES

static final java.lang.String[] PERSISTENCES
An array containing all legal persistence values