A D I K L M S

A

Assertion - class synergy.debug.Assertion.

This class allows the coders to put in code that simply checks a boolean value or statement and logs the results accordingly.

Assertion() - Constructor for class synergy.debug.Assertion

D

dateFormat - Static variable in class synergy.debug.Debug

The default date format

dateFormatter - Static variable in class synergy.debug.Debug

The date formatter class

Debug - class synergy.debug.Debug.

The debug class provides an alternative to the System.out.println and print methods.

Debug() - Constructor for class synergy.debug.Debug

debugLevel - Static variable in class synergy.debug.Debug

The debug level this is at

doAssert(boolean) - Static method in class synergy.debug.Assertion

This method will check the given condition and, if it fails, will generate a fatal error, log it in the log file and exit the system.

doAssert(boolean, String) - Static method in class synergy.debug.Assertion

This will accept a given condition and if it failed, log the message in the log file as a fatal error and exit the system.

doDirRecurse(File) - Method in class synergy.debug.Strip

When this method is called, it runs through the source files recurisvely from the directory the program was started in and comments out all the debug information.

doError(String, int) - Static method in class synergy.debug.Log

This will write the given error message to the log file along with the error level.

doError(String, String, int) - Static method in class synergy.debug.Log

This will write the given error message to the log file along with the error level.

doFatalError(String) - Static method in class synergy.debug.Log

This will always write the fatal error message to the log file and exit the application no matter what the current run level is.

doInitialisation() - Static method in class synergy.debug.Debug

This method will initialise the Debug class with the defaults, or the text file provided.

doInitialisation() - Static method in class synergy.debug.Log

This method will initialise the Debug class with the defaults, or the text file provided.

doPrint(String) - Static method in class synergy.debug.Debug

Performs the same functionality as the System.out.println() method but also logs the message in a log file.

doPrint(String, int) - Static method in class synergy.debug.Debug

This writes the given message to standard out and provides the runLevel in which the debug message should be presented.

doPrintln(String) - Static method in class synergy.debug.Debug

Performs the same functionality as the System.out.println() method but also logs the message in a log file.

doPrintln(String) - Static method in class synergy.debug.Log

Places the given warning message into the log file if the current debug level allows it.

doPrintln(String, int) - Static method in class synergy.debug.Debug

This writes the given message to standard out and provides the runLevel in which the debug message should be presented.

doProcessing(File) - Method in class synergy.debug.Strip

This method will comment out all the debuggin info from the given file.

doWarning(boolean) - Static method in class synergy.debug.Assertion

This method will check the given condition and, if it fails, will generate a warning, log it in the log file and return the value of the assertion.

doWarning(boolean, String) - Static method in class synergy.debug.Assertion

This will accept a given condition and if it failed, log the message in the log file as a warning.

doWarning(String) - Static method in class synergy.debug.Log

Places the given warning message into the log file if the current debug level allows it.

doWarning(String, String) - Static method in class synergy.debug.Log

Places the given warning message into the log file if the current debug level allows it.

I

isInitialised() - Static method in class synergy.debug.Debug

This method will indicate whether the Debug class has been intialised.

K

kErrorLevel - Static variable in class synergy.debug.Debug

Highly important debug levels

kFatalLevel - Static variable in class synergy.debug.Debug

Anything above this value will always be logged

kPrintLevel - Static variable in class synergy.debug.Debug

The lowest level debug level, least important

kPropertiesFileName - Static variable in class synergy.debug.Debug

The name of the file with the debug properties in it

kRunLevel - Static variable in class synergy.debug.Debug

The constant name of the run level property

kTimeStampFormat - Static variable in class synergy.debug.Debug

The constant name of the time stamp format property

kWarningLevel - Static variable in class synergy.debug.Debug

Moderately important debug levels

L

Log - class synergy.debug.Log.

The log class will allow messages to be written to a log file.

Log() - Constructor for class synergy.debug.Log

M

main(String[]) - Static method in class synergy.debug.Strip

When the Strip application is run, this method is called.

S

setStrip(boolean) - Method in class synergy.debug.Strip

Sets the functionality of the application to either stripping or reviving

Strip - class synergy.debug.Strip.

The strip application will act as a pre-processor to the compiler, it will run through the source files in the specified directory and (if requested) recursively comment out or uncomment the debug information in the code.

Strip() - Constructor for class synergy.debug.Strip

synergy.debug - package synergy.debug

A D I K L M S