com.planet_ink.coffee_mud.core
Class Log

java.lang.Object
  com.planet_ink.coffee_mud.core.Log

public class Log
extends java.lang.Object

Nested Class Summary

static interface

Log.LogReader

Field Summary

static java.text.SimpleDateFormat

dateFormat final date format for headers

Constructor Summary

Log()

Method Summary

void	close() Shut down this class forever
static boolean	combatChannelAt(int priority)
static boolean	combatChannelOn()
static void	combatOut(java.lang.String Out)
static void	combatOut(java.lang.String Out, int priority)
static void	combatOut(java.lang.String Module, java.lang.String Message)
static void	combatOut(java.lang.String Module, java.lang.String Message, int priority)
static boolean	debugChannelAt(int priority)
static boolean	debugChannelOn()
static void	debugOut(java.lang.String Out)
static void	debugOut(java.lang.String Module, java.lang.Exception e)
static void	debugOut(java.lang.String Out, int priority)
static void	debugOut(java.lang.String Module, int priority, java.lang.Exception e)
static void	debugOut(java.lang.String Module, java.lang.String Message)
static void	debugOut(java.lang.String Module, java.lang.String Message, int priority)
static boolean	errorChannelAt(int priority)
static boolean	errorChannelOn()
static void	errOut(java.lang.String Out)
static void	errOut(java.lang.String Out, int priority)
static void	errOut(java.lang.String Module, int priority, java.lang.Throwable e)
static void	errOut(java.lang.String Module, java.lang.String Message)
static void	errOut(java.lang.String Module, java.lang.String Message, int priority)
static void	errOut(java.lang.String Module, java.lang.Throwable e)
java.lang.StringBuffer	getLog()
java.lang.String	getLogFilename(java.lang.String name)
java.lang.String	getLogLocation() Start all of the log files Usage: path = getLogLocation();
Log.LogReader	getLogReader()
static boolean	helpChannelAt(int priority)
static boolean	helpChannelOn()
static void	helpOut(java.lang.String Out)
static void	helpOut(java.lang.String Out, int priority)
static void	helpOut(java.lang.String Module, java.lang.String Message)
static void	helpOut(java.lang.String Module, java.lang.String Message, int priority)
static boolean	infoChannelAt(int priority)
static boolean	infoChannelOn()
static void	infoOut(java.lang.String Out)
static void	infoOut(java.lang.String Out, int priority)
static void	infoOut(java.lang.String Module, java.lang.String Message)
static void	infoOut(java.lang.String Module, java.lang.String Message, int priority)
static Log	instance()
static boolean	isMaskedErrMsg(java.lang.String str) Optional method to determine if message is a masked out throwable message type.
static boolean	killsChannelAt(int priority)
static boolean	killsChannelOn()
static void	killsOut(java.lang.String Out)
static void	killsOut(java.lang.String Out, int priority)
static void	killsOut(java.lang.String Module, java.lang.String Message)
static void	killsOut(java.lang.String Module, java.lang.String Message, int priority)
static Log	l(char threadCode)
static Log	newInstance()
int	numLines()
static void	rawStandardOut(java.lang.String Type, java.lang.String Message, int priority) Handles raw info logging entries.
static void	rawSysOut(java.lang.String Message)
static void	rawSysOut(java.lang.String Message, int priority)
void	setLogOutput(java.lang.String newSYSMSGS, java.lang.String newERRMSGS, java.lang.String newWARNMSGS, java.lang.String newDBGMSGS, java.lang.String newHLPMSGS, java.lang.String newKILMSGS, java.lang.String newCBTMSGS) Reset all of the log files ON, OFF, FILE, BOTH Usage: CMProps.Initialize("ON","OFF");
static void	shareWith(char threadCode)
static void	shortExOut(java.lang.String Type, java.lang.String Module, int priority, java.lang.Exception e) Handles error logging entries.
static void	standardExOut(java.lang.String Type, java.lang.String Module, int priority, java.lang.Throwable e) Handles long exception logging entries.
void	startLogFiles(java.lang.String newLogName, int numberOfLogs) Start all of the log files in the info temp directory Usage: startLogFiles(5);
void	startLogFiles(java.lang.String newLogName, java.lang.String dirPath, int numberOfLogs) Start all of the log files in the specified directory Usage: startLogFiles("mud","",10);
static void	sysOut(java.lang.String Out)
static void	sysOut(java.lang.String Out, int priority)
static void	sysOut(java.lang.String Module, java.lang.String Message)
static void	sysOut(java.lang.String Out, java.lang.String Message, int priority)
static void	timeOut(java.lang.String Type, java.lang.String Module, java.lang.String Message, int priority) Handles debug timing entries.
static boolean	warnChannelAt(int priority)
static boolean	warnChannelOn()
static void	warnOut(java.lang.String Out)
static void	warnOut(java.lang.String Out, int priority)
static void	warnOut(java.lang.String Module, int priority, java.lang.Throwable e)
static void	warnOut(java.lang.String Module, java.lang.String Message)
static void	warnOut(java.lang.String Module, java.lang.String Message, int priority)
static void	warnOut(java.lang.String Module, java.lang.Throwable e)

Methods inherited from class java.lang.Object

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

Field Detail

dateFormat

public static final java.text.SimpleDateFormat dateFormat

final date format for headers

Constructor Detail

Log

public Log()

Method Detail

l

public static final Log l(char threadCode)

instance

public static final Log instance()

newInstance

public static final Log newInstance()

shareWith

public static final void shareWith(char threadCode)

isMaskedErrMsg

public static final boolean isMaskedErrMsg(java.lang.String str)

Optional method to determine if message is a masked out throwable message type.

Usage: if(isMaskedErrMsg(errException.getMessage()))

Parameters:

str - the message

Returns:

boolean TRUE if masked out.

getLogFilename

public final java.lang.String getLogFilename(java.lang.String name)

setLogOutput

public final void setLogOutput(java.lang.String newSYSMSGS,
                               java.lang.String newERRMSGS,
                               java.lang.String newWARNMSGS,
                               java.lang.String newDBGMSGS,
                               java.lang.String newHLPMSGS,
                               java.lang.String newKILMSGS,
                               java.lang.String newCBTMSGS)

Reset all of the log files ON, OFF, FILE, BOTH

Usage: CMProps.Initialize("ON","OFF");

Parameters:

newSYSMSGS - code string to describe info msgs

newERRMSGS - code string to describe error msgs

newWARNMSGS - code string to describe warning msgs

newDBGMSGS - code string to describe debug msgs

newHLPMSGS - code string to describe help msgs

startLogFiles

public final void startLogFiles(java.lang.String newLogName,
                                int numberOfLogs)

Start all of the log files in the info temp directory

Usage: startLogFiles(5);

Parameters:

numberOfLogs - maximum number of files

startLogFiles

public final void startLogFiles(java.lang.String newLogName,
                                java.lang.String dirPath,
                                int numberOfLogs)

Start all of the log files in the specified directory

Usage: startLogFiles("mud","",10);

Parameters:

dirPath - the place to create the file

numberOfLogs - maximum number of files

numLines

public final int numLines()

getLogReader

public final Log.LogReader getLogReader()

getLog

public final java.lang.StringBuffer getLog()

getLogLocation

public final java.lang.String getLogLocation()

Start all of the log files

Usage: path = getLogLocation();

Returns:

the string representation of the file path

infoOut

public static final void infoOut(java.lang.String Out)

sysOut

public static final void sysOut(java.lang.String Out)

debugOut

public static final void debugOut(java.lang.String Out)

errOut

public static final void errOut(java.lang.String Out)

warnOut

public static final void warnOut(java.lang.String Out)

helpOut

public static final void helpOut(java.lang.String Out)

killsOut

public static final void killsOut(java.lang.String Out)

combatOut

public static final void combatOut(java.lang.String Out)

sysOut

public static final void sysOut(java.lang.String Module,
                                java.lang.String Message)

infoOut

public static final void infoOut(java.lang.String Module,
                                 java.lang.String Message)

errOut

public static final void errOut(java.lang.String Module,
                                java.lang.String Message)

warnOut

public static final void warnOut(java.lang.String Module,
                                 java.lang.String Message)

debugOut

public static final void debugOut(java.lang.String Module,
                                  java.lang.String Message)

helpOut

public static final void helpOut(java.lang.String Module,
                                 java.lang.String Message)

killsOut

public static final void killsOut(java.lang.String Module,
                                  java.lang.String Message)

combatOut

public static final void combatOut(java.lang.String Module,
                                   java.lang.String Message)

debugOut

public static final void debugOut(java.lang.String Module,
                                  java.lang.Exception e)

errOut

public static final void errOut(java.lang.String Module,
                                java.lang.Throwable e)

warnOut

public static final void warnOut(java.lang.String Module,
                                 java.lang.Throwable e)

rawSysOut

public static final void rawSysOut(java.lang.String Message)

infoOut

public static final void infoOut(java.lang.String Out,
                                 int priority)

sysOut

public static final void sysOut(java.lang.String Out,
                                int priority)

debugOut

public static final void debugOut(java.lang.String Out,
                                  int priority)

errOut

public static final void errOut(java.lang.String Out,
                                int priority)

warnOut

public static final void warnOut(java.lang.String Out,
                                 int priority)

helpOut

public static final void helpOut(java.lang.String Out,
                                 int priority)

killsOut

public static final void killsOut(java.lang.String Out,
                                  int priority)

combatOut

public static final void combatOut(java.lang.String Out,
                                   int priority)

infoOut

public static final void infoOut(java.lang.String Module,
                                 java.lang.String Message,
                                 int priority)

sysOut

public static final void sysOut(java.lang.String Out,
                                java.lang.String Message,
                                int priority)

errOut

public static final void errOut(java.lang.String Module,
                                java.lang.String Message,
                                int priority)

warnOut

public static final void warnOut(java.lang.String Module,
                                 java.lang.String Message,
                                 int priority)

debugOut

public static final void debugOut(java.lang.String Module,
                                  java.lang.String Message,
                                  int priority)

helpOut

public static final void helpOut(java.lang.String Module,
                                 java.lang.String Message,
                                 int priority)

killsOut

public static final void killsOut(java.lang.String Module,
                                  java.lang.String Message,
                                  int priority)

combatOut

public static final void combatOut(java.lang.String Module,
                                   java.lang.String Message,
                                   int priority)

debugOut

public static final void debugOut(java.lang.String Module,
                                  int priority,
                                  java.lang.Exception e)

errOut

public static final void errOut(java.lang.String Module,
                                int priority,
                                java.lang.Throwable e)

warnOut

public static final void warnOut(java.lang.String Module,
                                 int priority,
                                 java.lang.Throwable e)

rawSysOut

public static final void rawSysOut(java.lang.String Message,
                                   int priority)

standardExOut

public static final void standardExOut(java.lang.String Type,
                                       java.lang.String Module,
                                       int priority,
                                       java.lang.Throwable e)

Handles long exception logging entries. Sends them to System.out, the log file, or nowhere.

Usage: standardExOut("UNKN",Out);

Parameters:

Type - The channel to print to

Module - The module to print

e - The exception whose string one wishes to print

shortExOut

public static final void shortExOut(java.lang.String Type,
                                    java.lang.String Module,
                                    int priority,
                                    java.lang.Exception e)

Handles error logging entries. Sends them to System.out, the log file, or nowhere.

Usage: shortExOut("Info","UNKN",Out);

Parameters:

Type - The type of channel

Module - The message to print

e - The exception whose string one wishes to print

rawStandardOut

public static final void rawStandardOut(java.lang.String Type,
                                        java.lang.String Message,
                                        int priority)

Handles raw info logging entries. Sends them to System.out, the log file, or nowhere.

Usage: rawStandardOut("Info","REQ-OUT:"+REQ);

Parameters:

Type - The type of message

Message - The message to print

priority - The priority of the message, high is less priority, 0=always

timeOut

public static final void timeOut(java.lang.String Type,
                                 java.lang.String Module,
                                 java.lang.String Message,
                                 int priority)

Handles debug timing entries. Sends them to System.out, the log file, or nowhere.

Usage: timeOut("Info","UNKN",Out);

Parameters:

Type - Channel name

Module - The file name

Message - The message to print

priority - The priority of the message, high is less priority, 0=always

close

public final void close()

Shut down this class forever

errorChannelOn

public static final boolean errorChannelOn()

helpChannelOn

public static final boolean helpChannelOn()

debugChannelOn

public static final boolean debugChannelOn()

infoChannelOn

public static final boolean infoChannelOn()

warnChannelOn

public static final boolean warnChannelOn()

killsChannelOn

public static final boolean killsChannelOn()

combatChannelOn

public static final boolean combatChannelOn()

errorChannelAt

public static final boolean errorChannelAt(int priority)

helpChannelAt

public static final boolean helpChannelAt(int priority)

debugChannelAt

public static final boolean debugChannelAt(int priority)

infoChannelAt

public static final boolean infoChannelAt(int priority)

warnChannelAt

public static final boolean warnChannelAt(int priority)

killsChannelAt

public static final boolean killsChannelAt(int priority)

combatChannelAt

public static final boolean combatChannelAt(int priority)