main

Class EcologiaIO

java.lang.Object

main.EcologiaIO

public abstract class EcologiaIO
extends java.lang.Object

This class provides unified I/O methods for debugging, logging, error messages, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	analysing
static int	BREAK_ERROR
static int	CONTINUABLE_ERROR
static boolean	debugging
static int	FATAL_ERROR
static boolean	logging
static boolean	verbose

Constructor Summary

Constructors

Constructor and Description
EcologiaIO()

Method Summary

Modifier and Type	Method and Description
static void	analysis(java.lang.String message) Print an analysis message if the analysing flag is set.
static void	archiveLog() Archive the current log file, ready for a new run
static void	debug(java.lang.String message) Print a debug message if the debug flag is set.
static void	error(java.lang.String message) Print an error message
static void	error(java.lang.String message, java.lang.Exception error) Print an error message and the stack trace
static void	error(java.lang.String message, int errorType) Give an error message and pause/shut down
private static java.lang.String	getDate()
static void	log(java.lang.String message) Print a log message if the verbose flag is set.
static void	printStatus() Print out which flags are set.
private static void	writeFile(java.lang.String message) Write a message to file

Methods inherited from class java.lang.Object

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

Field Detail

verbose

public static boolean verbose

debugging

public static boolean debugging

analysing

public static boolean analysing

logging

public static boolean logging

CONTINUABLE_ERROR

public static final int CONTINUABLE_ERROR

See Also:

Constant Field Values

BREAK_ERROR

public static final int BREAK_ERROR

See Also:

Constant Field Values

FATAL_ERROR

public static final int FATAL_ERROR

See Also:

Constant Field Values

Constructor Detail

EcologiaIO

public EcologiaIO()

Method Detail

log

public static void log(java.lang.String message)

Print a log message if the verbose flag is set. This is meant to be used for important runtime events in the program, and for fundamental (e.g. birth and death) events during the simulation. For more detailed output, use either debug() or analysis().

Parameters:

message -

debug

public static void debug(java.lang.String message)

Print a debug message if the debug flag is set. This is primarily intended for use during development. Experimental data should go to analysis(), important messages to log().

Parameters:

message -

analysis

public static void analysis(java.lang.String message)

Print an analysis message if the analysing flag is set. This is meant to be used for simulation data output relevant only to a current experiment. FIXME A lot of analysis() calls slow the program down drastically. Implement caching?

Parameters:

message -

error

public static void error(java.lang.String message)

Print an error message

Parameters:

message -

error

public static void error(java.lang.String message,
                         java.lang.Exception error)

Print an error message and the stack trace

Parameters:

message -

error -

error

public static void error(java.lang.String message,
                         int errorType)

Give an error message and pause/shut down

Parameters:

message -

errorType - CONTINUABLE_ERROR, BREAK_ERROR, FATAL_ERROR

archiveLog

public static void archiveLog()

Archive the current log file, ready for a new run

printStatus

public static void printStatus()

Print out which flags are set.

writeFile

private static void writeFile(java.lang.String message)

Write a message to file

getDate

private static java.lang.String getDate()

Returns:

time stamp