Package anecho.JamochaMUD

Class JMConfig

java.lang.Object

anecho.JamochaMUD.JMConfig

public final class JMConfig
extends java.lang.Object

This class is used for easy access to user variables and settings

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALTFOCUS
static java.lang.String	ANTIALIAS
static java.lang.String	AUTOFOCUSINPUT
static java.lang.String	AUTOLOGGING
static java.lang.String	AUTOLOGPATH	The path to where automatic logfiles are to be saved (not to be confused with dumped log files)
static java.lang.String	BACKGROUNDCOLOUR
static java.lang.String	BGPAINT
static java.lang.String	BROWSER1
static java.lang.String	BROWSER2
static java.lang.String	BROWSERINSTANCE1
static java.lang.String	BROWSERINSTANCE2
static java.lang.String	BUNDLEBASE
static java.lang.String	CONNECTIONHANDLER
static java.lang.String	CONNMUCK
static java.lang.String	CONNPORT
static java.lang.String	CONNSSL
static java.lang.String	CUSTOMPALETTE
static java.lang.String	DATABAR
static java.lang.String	DATAINVARIABLE
static java.lang.String	DISKLESSCONFIG
static java.lang.String	DIVIDERLOCATION
static java.lang.String	DOIMPORT
static java.lang.String	DOUBLEBUFFER
static java.lang.String	EMAILCLIENT
static java.lang.String	ENUMERATOR
static java.lang.String	EXTMUDIMAGE	The remote image to load when JamochaMUD is co-branded
static java.lang.String	EXTMUDLIST	The address to be used for loading external site mudlists
static java.lang.String	FONTFACE
static java.lang.String	FOREGROUNDCOLOUR
static java.lang.String	FTPCLIENT
static java.lang.String	HISTORYLENGTH
static java.lang.String	ICONIMAGE
static java.lang.String	ISNEW	Identifies whether the current version of JamochaMUD is newer than the previously run version
static java.lang.String	JMUDCORE
static java.lang.String	LASTMU
static java.lang.String	LOCALECHO
static java.lang.String	LOGFILENAMEFORMAT	The format used for the continuous logging logfile
static java.lang.String	LOGPATH	The path to where dumped logfiles are to be saved (not to be confused with automatic log files)
static java.lang.String	LOWCOLOUR
static java.lang.String	MACRODEFS
static java.lang.String	MACROFRAME
static java.lang.String	MACROLABELS
static java.lang.String	MACROVISIBLE
static java.lang.String	MAINLAYOUTVALID
static java.lang.String	MAINWINDOW
static java.lang.String	MAINWINDOWICONIFIED
static java.lang.String	MAINWINDOWVARIABLE
static java.lang.String	MANUALEXTLIST	This variable allows the user to manually pass the tags used to parse a MUD XML file
static java.lang.String	MASTERPLUGINDIR
static java.lang.String	MUCKCONNVISIBLE
static java.lang.String	MUCKLIST
static java.lang.String	MUCKMAINTITLE
static java.lang.String	MUDCONNECTORLIST	Whether to use the MudConnector.com MU* list
static java.lang.String	MUDLISTTYPE	Allows the user to define the MUD XML file type based on existing types
static java.lang.String	OSNAME
static java.lang.String	PATHSEPARATOR
static java.lang.String	PLUGENUMERATOR
static java.lang.String	PLUGINNAME
static java.lang.String	PLUGINSTATUS
static java.lang.String	PROXY
static java.lang.String	PROXYHOST
static java.lang.String	PROXYPORT
static java.lang.String	QUIETRC
static java.lang.String	RELEASEPAUSE
static java.lang.String	SCREENSIZE
static java.lang.String	SHOWNEW	Identifies whether the user wants to show JamochaMUD update information or not
static java.lang.String	SINGLEUSERMODE
static java.lang.String	SPELLCHECK
static java.lang.String	SPLITVIEW
static java.lang.String	SYNCWINDOWS
static java.lang.String	TFKEYEMU
static java.lang.String	TIMERS
static java.lang.String	TIMERSVISIBLE
static java.lang.String	USERDIRECTORY
static java.lang.String	USERPLUGINDIR	The directory where plug-ins should be installed by the JamochaMUD plug-in installer.
static java.lang.String	USESWING
static java.lang.String	USESWINGENTRY
static java.lang.String	USEUNICODE
static java.lang.String	WORKINGDIRECTORY
static java.lang.String	WORLD

Method Summary

Modifier and Type	Method	Description
void	addDefinition(java.lang.String name, java.lang.String value)	Store a user-defined definition
void	addVariable(java.lang.String name, java.lang.String value)	Add a new user-variable or change the definition of an existing one
java.util.Hashtable	getAllDefinitions()	This method returns a hashtable defining all the user-defined definitions
java.util.Hashtable	getAllSettings()	This method is most commonly called when one wants to back-up the current JamochaMUD settings.
java.util.Hashtable	getAllVariables()
java.lang.String	getBundleBase()	This returns the base path to our language resource bundles
CHandler	getConnectionHandler()
DataIn	getDataInVariable()
java.lang.String	getDefinition(java.lang.String name)
java.awt.Image	getIconImage()
static JMConfig	getInstance()
boolean	getJMboolean(java.lang.String item)	Returns a boolean from the variable hashtable
java.awt.Color	getJMColor(java.lang.String item)	Returns a colour from the hashtable
JMUD	getJMCore()
java.awt.Font	getJMFont(java.lang.String item)	This method returns the Font represented by the given key
java.awt.Frame	getJMFrame(java.lang.String item)	Returns the Frame object for the specified variable
int	getJMint(java.lang.String item)	Returns an integer from the JamochaMUD variable hashtable
java.lang.Object	getJMObject(java.lang.String item)
java.awt.Rectangle	getJMRectangle(java.lang.String item)
java.lang.String	getJMString(java.lang.String item)	Returns a String from the JamochaMUD variables
java.lang.String[]	getJMStringArray(java.lang.String item)	Returns a string array based on the provided item.
java.util.Vector	getJMVector(java.lang.String item)	Returns a vector from the JamochaMUD configuration specified by the
MuckMain	getMainWindowVariable()	Deprecated. MuckMain is now a singleton, information may be retrieved via MuckMain.getInstance()
java.awt.Dimension	getScreenSize()
java.lang.String	getVariable(java.lang.String name)	Get the value of the given user-variable name
boolean	removeDefinition(java.lang.String name)	Remove the given definition from the Hashtable
boolean	removeVariable(java.lang.String name)	Remove the selected variable from the list of user-variables
void	setAllSettings(java.util.Hashtable newVars)	Change all our settings to that of the new Hashtable.
void	setConnectionHandler(CHandler connection)	Deprecated. the ConnectionHandler will be turned into a singleton
void	setDataInVariable(DataIn variable)
void	setIconImage(java.awt.Image icon)
void	setJMboolean(java.lang.String objName, java.lang.String setting)	Deprecated.
void	setJMCore(JMUD core)
void	setJMObject(java.lang.String objName, java.lang.Object value)	Deprecated.
void	setJMValue(java.lang.String objName, boolean setting)	Set a value to our configuration containing a boolean value
void	setJMValue(java.lang.String objName, int setting)	This method sets an Integer value to a given key stored in the user variables
void	setJMValue(java.lang.String objName, java.lang.Object value)	This method sets an Object to a given key stored in the user variables
void	setMainWindowVariable(MuckMain variable)	Deprecated. MuckMain is now a singleton, information may be retrieved via MuckMain.getInstance()
void	setPlugEnumerator(EnumPlugIns plugEnum)
void	setScreenSize(java.awt.Dimension screen)

Methods inherited from class java.lang.Object

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

Field Detail

AUTOFOCUSINPUT

public static final java.lang.String AUTOFOCUSINPUT

AUTOLOGGING

public static final java.lang.String AUTOLOGGING

ALTFOCUS

public static final java.lang.String ALTFOCUS

ANTIALIAS

public static final java.lang.String ANTIALIAS

BACKGROUNDCOLOUR

public static final java.lang.String BACKGROUNDCOLOUR

BGPAINT

public static final java.lang.String BGPAINT

BROWSER1

public static final java.lang.String BROWSER1

BROWSERINSTANCE1

public static final java.lang.String BROWSERINSTANCE1

BROWSER2

public static final java.lang.String BROWSER2

BROWSERINSTANCE2

public static final java.lang.String BROWSERINSTANCE2

CONNECTIONHANDLER

public static final java.lang.String CONNECTIONHANDLER

CONNMUCK

public static final java.lang.String CONNMUCK

CONNPORT

public static final java.lang.String CONNPORT

CONNSSL

public static final java.lang.String CONNSSL

CUSTOMPALETTE

public static final java.lang.String CUSTOMPALETTE

DATABAR

public static final java.lang.String DATABAR

DATAINVARIABLE

public static final java.lang.String DATAINVARIABLE

DIVIDERLOCATION

public static final java.lang.String DIVIDERLOCATION

DOIMPORT

public static final java.lang.String DOIMPORT

DOUBLEBUFFER

public static final java.lang.String DOUBLEBUFFER

HISTORYLENGTH

public static final java.lang.String HISTORYLENGTH

EMAILCLIENT

public static final java.lang.String EMAILCLIENT

ENUMERATOR

public static final java.lang.String ENUMERATOR

EXTMUDLIST

public static final java.lang.String EXTMUDLIST

The address to be used for loading external site mudlists

See Also:

Constant Field Values

EXTMUDIMAGE

public static final java.lang.String EXTMUDIMAGE

The remote image to load when JamochaMUD is co-branded

See Also:

Constant Field Values

MUDLISTTYPE

public static final java.lang.String MUDLISTTYPE

Allows the user to define the MUD XML file type based on existing types

See Also:

Constant Field Values

MANUALEXTLIST

public static final java.lang.String MANUALEXTLIST

This variable allows the user to manually pass the tags used to parse a MUD XML file

See Also:

Constant Field Values

FONTFACE

public static final java.lang.String FONTFACE

FOREGROUNDCOLOUR

public static final java.lang.String FOREGROUNDCOLOUR

FTPCLIENT

public static final java.lang.String FTPCLIENT

ICONIMAGE

public static final java.lang.String ICONIMAGE

ISNEW

public static final java.lang.String ISNEW

Identifies whether the current version of JamochaMUD is newer than the previously run version

See Also:

Constant Field Values

JMUDCORE

public static final java.lang.String JMUDCORE

LASTMU

public static final java.lang.String LASTMU

LOGPATH

public static final java.lang.String LOGPATH

The path to where dumped logfiles are to be saved (not to be confused with automatic log files)

AUTOLOGPATH

public static final java.lang.String AUTOLOGPATH

The path to where automatic logfiles are to be saved (not to be confused with dumped log files)

See Also:

Constant Field Values

LOGFILENAMEFORMAT

public static final java.lang.String LOGFILENAMEFORMAT

The format used for the continuous logging logfile

See Also:

Constant Field Values

LOCALECHO

public static final java.lang.String LOCALECHO

LOWCOLOUR

public static final java.lang.String LOWCOLOUR

MACROFRAME

public static final java.lang.String MACROFRAME

MACRODEFS

public static final java.lang.String MACRODEFS

MACROLABELS

public static final java.lang.String MACROLABELS

MACROVISIBLE

public static final java.lang.String MACROVISIBLE

MAINLAYOUTVALID

public static final java.lang.String MAINLAYOUTVALID

MAINWINDOW

public static final java.lang.String MAINWINDOW

MAINWINDOWICONIFIED

public static final java.lang.String MAINWINDOWICONIFIED

MAINWINDOWVARIABLE

public static final java.lang.String MAINWINDOWVARIABLE

MASTERPLUGINDIR

public static final java.lang.String MASTERPLUGINDIR

MUCKCONNVISIBLE

public static final java.lang.String MUCKCONNVISIBLE

MUCKLIST

public static final java.lang.String MUCKLIST

MUCKMAINTITLE

public static final java.lang.String MUCKMAINTITLE

MUDCONNECTORLIST

public static final java.lang.String MUDCONNECTORLIST

Whether to use the MudConnector.com MU* list

See Also:

Constant Field Values

OSNAME

public static final java.lang.String OSNAME

PATHSEPARATOR

public static final java.lang.String PATHSEPARATOR

PLUGENUMERATOR

public static final java.lang.String PLUGENUMERATOR

PLUGINNAME

public static final java.lang.String PLUGINNAME

PLUGINSTATUS

public static final java.lang.String PLUGINSTATUS

DISKLESSCONFIG

public static final java.lang.String DISKLESSCONFIG

See Also:

Constant Field Values

PROXY

public static final java.lang.String PROXY

PROXYHOST

public static final java.lang.String PROXYHOST

PROXYPORT

public static final java.lang.String PROXYPORT

QUIETRC

public static final java.lang.String QUIETRC

See Also:

Constant Field Values

RELEASEPAUSE

public static final java.lang.String RELEASEPAUSE

SCREENSIZE

public static final java.lang.String SCREENSIZE

SHOWNEW

public static final java.lang.String SHOWNEW

Identifies whether the user wants to show JamochaMUD update information or not

See Also:

Constant Field Values

SINGLEUSERMODE

public static final java.lang.String SINGLEUSERMODE

SPLITVIEW

public static final java.lang.String SPLITVIEW

SYNCWINDOWS

public static final java.lang.String SYNCWINDOWS

SPELLCHECK

public static final java.lang.String SPELLCHECK

TFKEYEMU

public static final java.lang.String TFKEYEMU

TIMERS

public static final java.lang.String TIMERS

TIMERSVISIBLE

public static final java.lang.String TIMERSVISIBLE

USESWING

public static final java.lang.String USESWING

USESWINGENTRY

public static final java.lang.String USESWINGENTRY

USEUNICODE

public static final java.lang.String USEUNICODE

USERDIRECTORY

public static final java.lang.String USERDIRECTORY

USERPLUGINDIR

public static final java.lang.String USERPLUGINDIR

The directory where plug-ins should be installed by the JamochaMUD plug-in installer. It is also the base dir for all plug-in settings

WORKINGDIRECTORY

public static final java.lang.String WORKINGDIRECTORY

WORLD

public static final java.lang.String WORLD

BUNDLEBASE

public static final java.lang.String BUNDLEBASE

Method Detail

getInstance

public static JMConfig getInstance()

Returns:

setJMValue

public void setJMValue(java.lang.String objName,
                       boolean setting)

Set a value to our configuration containing a boolean value

Parameters:

objName - A string defining the setting's name

setting - The boolean value to be attributed to our objName

setJMValue

public void setJMValue(java.lang.String objName,
                       int setting)

This method sets an Integer value to a given key stored in the user variables

Parameters:

objName - The key to use

setting - The Integer to be stored with the given key

setJMValue

public void setJMValue(java.lang.String objName,
                       java.lang.Object value)

This method sets an Object to a given key stored in the user variables

Parameters:

objName - The key to use

value - The object to be stored with the given key

setJMboolean

public void setJMboolean(java.lang.String objName,
                         java.lang.String setting)

Deprecated.

This method sets a String to a given key stored in the user variables

Parameters:

objName - The key to use

setting - The String to be stored with the given key

setJMObject

public void setJMObject(java.lang.String objName,
                        java.lang.Object value)

Deprecated.

Sets an key and value pair in the vars Hashtable

Parameters:

objName -

value - The Object to be stored with the given key

getJMObject

public java.lang.Object getJMObject(java.lang.String item)

Parameters:

item -

Returns:

getJMFrame

public java.awt.Frame getJMFrame(java.lang.String item)

Returns the Frame object for the specified variable

Parameters:

item - The frame object to be returned

Returns:

getJMRectangle

public java.awt.Rectangle getJMRectangle(java.lang.String item)

Returns:

getJMString

public java.lang.String getJMString(java.lang.String item)

Returns a String from the JamochaMUD variables

Parameters:

item -

Returns:

getJMStringArray

public java.lang.String[] getJMStringArray(java.lang.String item)

Returns a string array based on the provided item. If the @item is not in the configuration an empty array will be returned.

Parameters:

item -

Returns:

getJMboolean

public boolean getJMboolean(java.lang.String item)

Returns a boolean from the variable hashtable

Parameters:

item -

Returns:

getJMColor

public java.awt.Color getJMColor(java.lang.String item)

Returns a colour from the hashtable

Parameters:

item -

Returns:

getJMint

public int getJMint(java.lang.String item)

Returns an integer from the JamochaMUD variable hashtable

Parameters:

item - The key to use to look up the Integer

Returns:

An integer represented by the given key. Keys that don't exist returns -1

getJMFont

public java.awt.Font getJMFont(java.lang.String item)

This method returns the Font represented by the given key

Parameters:

item - The key to use to look up the font

Returns:

The font represented by the objName key

getJMVector

public java.util.Vector getJMVector(java.lang.String item)

Returns a vector from the JamochaMUD configuration specified by the

Parameters:

item - The item to look up

Returns:

setIconImage

public void setIconImage(java.awt.Image icon)

Parameters:

icon -

getIconImage

public java.awt.Image getIconImage()

Returns:

setScreenSize

public void setScreenSize(java.awt.Dimension screen)

Parameters:

screen -

getScreenSize

public java.awt.Dimension getScreenSize()

Returns:

setConnectionHandler

public void setConnectionHandler(CHandler connection)

Deprecated. the ConnectionHandler will be turned into a singleton

Parameters:

connection -

getConnectionHandler

public CHandler getConnectionHandler()

Returns:

setJMCore

public void setJMCore(JMUD core)

Parameters:

core -

getJMCore

public JMUD getJMCore()

Returns:

setDataInVariable

public void setDataInVariable(DataIn variable)

Parameters:

variable -

getDataInVariable

public DataIn getDataInVariable()

Returns:

setMainWindowVariable

public void setMainWindowVariable(MuckMain variable)

Deprecated. MuckMain is now a singleton, information may be retrieved via MuckMain.getInstance()

Parameters:

variable -

getMainWindowVariable

public MuckMain getMainWindowVariable()

Deprecated. MuckMain is now a singleton, information may be retrieved via MuckMain.getInstance()

Returns:

setPlugEnumerator

public void setPlugEnumerator(EnumPlugIns plugEnum)

Parameters:

plugEnum -

getBundleBase

public java.lang.String getBundleBase()

This returns the base path to our language resource bundles

Returns:

*

addVariable

public void addVariable(java.lang.String name,
                        java.lang.String value)

Add a new user-variable or change the definition of an existing one

Parameters:

name -

value - *

getVariable

public java.lang.String getVariable(java.lang.String name)

Get the value of the given user-variable name

Parameters:

name -

Returns:

*

removeVariable

public boolean removeVariable(java.lang.String name)

Remove the selected variable from the list of user-variables

Parameters:

name - The name of the user defined variable to remove

Returns:

trueThe variable was successfully unset false The variable does not exist

getAllVariables

public java.util.Hashtable getAllVariables()

Returns:

addDefinition

public void addDefinition(java.lang.String name,
                          java.lang.String value)

Store a user-defined definition

Parameters:

name - the name of the definition to be stored

value - the value of the definition to be stored

getDefinition

public java.lang.String getDefinition(java.lang.String name)

Parameters:

name -

Returns:

removeDefinition

public boolean removeDefinition(java.lang.String name)

Remove the given definition from the Hashtable

Parameters:

name -

Returns:

getAllDefinitions

public java.util.Hashtable getAllDefinitions()

This method returns a hashtable defining all the user-defined definitions

Returns:

All user-defined definitions

getAllSettings

public java.util.Hashtable getAllSettings()

This method is most commonly called when one wants to back-up the current JamochaMUD settings. This will return the hashtable with all the standard settings, excluding the definitions and variables

Returns:

Returns a complete hashtable of all JamochaMUD settings

setAllSettings

public void setAllSettings(java.util.Hashtable newVars)

Change all our settings to that of the new Hashtable. This should be done somewhere between the user termination of JamochaMUD and the closing of the JVM. We don't want old settings to over-write what has just been imported during shut-down.

Parameters:

newVars - A hashtable to replace all existing user variables