Package jasima.core.util

Class ConsolePrinter

java.lang.Object

jasima.core.util.ConsolePrinter

All Implemented Interfaces:

ExperimentListener, NotifierListener<Experiment,Experiment.ExperimentEvent>

public class ConsolePrinter
extends Object
implements ExperimentListener

Prints experiment messages to the console.

Author:

Torsten Hildebrandt

Nested Class Summary

Nested classes/interfaces inherited from interface jasima.core.experiment.ExperimentListener

ExperimentListener.AfterRunListener, ExperimentListener.BeforeRunListener, ExperimentListener.DoneListener, ExperimentListener.ErrorListener, ExperimentListener.FinallyListener, ExperimentListener.FinishedListener, ExperimentListener.FinishingListener, ExperimentListener.HandleOtherListener, ExperimentListener.InitializedListener, ExperimentListener.MultiExperimentCompletedTaskListener, ExperimentListener.PrintListener, ExperimentListener.ProduceResultsListener, ExperimentListener.RunPerformedListener, ExperimentListener.StartingListener

Constructor Summary

Constructors

Constructor	Description
ConsolePrinter()
ConsolePrinter(MsgCategory logLevel)
ConsolePrinter(MsgCategory logLevel, String logFormat)
ConsolePrinter(String logFormat)

Method Summary

Modifier and Type	Method	Description
void	afterRun(Experiment e)
void	beforeRun(Experiment e)
void	done(Experiment e)
void	error(Experiment e, Throwable t)
void	finished(Experiment e, Map<String,Object> results)
static String	getDescription(Experiment e)	Returns a textual representation of an experiment's properties and their current values.
Locale	getLocale()
String	getLogFormat()
MsgCategory	getLogLevel()
PrintWriter	getOut()
void	initialized(Experiment e)
boolean	isPrintStdEvents()
void	multiExperimentCompletedTask(Experiment e, Experiment runExperiment, Map<String,Object> runResults)
void	print(Experiment e, ExperimentMessage.ExpPrintMessage event)
static void	printEventList(Simulation sim)	Prints the current event list (including the current event) to the console.
static void	printEventList(PrintWriter out, Simulation sim)	Prints the current event list (including the current event) to the given PrintWriter.
static void	printResults(Experiment e, Map<String,Object> res)	Static method to prints the results res of an experiment e to System.out.
static void	printResults(PrintWriter out, Experiment e, Map<String,Object> res)	Static method to print the results res of an experiment e to a PrintWriter.
static void	printResults(PrintWriter out, Map<String,Object> res)	Static method to print the results res of an experiment or Simulation to a PrintWriter.
static void	printResults(Map<String,Object> res)	Static method to prints the results res of an experiment or Simulation to System.out.
void	setLocale(Locale locale)	Sets the Locale that is used when formatting messages.
void	setLogFormat(String logFormat)
void	setLogLevel(MsgCategory logLevel)
void	setOut(PrintWriter out)	Sets the PrintWriter where to send output.
void	setPrintStdEvents(boolean printStdEvents)	PrintStdEvents determines, if print events for standard events (like experiment starting) should be produced.
void	starting(Experiment e)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jasima.core.experiment.ExperimentListener

finalAction, finishing, handleOther, inform, produceResults, runPerformed

Constructor Detail

ConsolePrinter

public ConsolePrinter()

ConsolePrinter

public ConsolePrinter(MsgCategory logLevel)

ConsolePrinter

public ConsolePrinter(String logFormat)

ConsolePrinter

public ConsolePrinter(MsgCategory logLevel,
                      String logFormat)

Method Detail

print

public void print(Experiment e,
                  ExperimentMessage.ExpPrintMessage event)

Specified by:

print in interface ExperimentListener

starting

public void starting(Experiment e)

Specified by:

starting in interface ExperimentListener

initialized

public void initialized(Experiment e)

Specified by:

initialized in interface ExperimentListener

beforeRun

public void beforeRun(Experiment e)

Specified by:

beforeRun in interface ExperimentListener

afterRun

public void afterRun(Experiment e)

Specified by:

afterRun in interface ExperimentListener

done

public void done(Experiment e)

Specified by:

done in interface ExperimentListener

finished

public void finished(Experiment e,
                     Map<String,Object> results)

Specified by:

finished in interface ExperimentListener

error

public void error(Experiment e,
                  Throwable t)

Specified by:

error in interface ExperimentListener

multiExperimentCompletedTask

public void multiExperimentCompletedTask(Experiment e,
                                         Experiment runExperiment,
                                         Map<String,Object> runResults)

Specified by:

multiExperimentCompletedTask in interface ExperimentListener

getLogLevel

public MsgCategory getLogLevel()

setLogLevel

public void setLogLevel(MsgCategory logLevel)

getLogFormat

public String getLogFormat()

setLogFormat

public void setLogFormat(String logFormat)

getOut

public PrintWriter getOut()

setOut

public void setOut(PrintWriter out)

Sets the PrintWriter where to send output. If this is null, print events will be written to System.out.

Parameters:

out - The PrintWriter to use.

isPrintStdEvents

public boolean isPrintStdEvents()

setPrintStdEvents

public void setPrintStdEvents(boolean printStdEvents)

PrintStdEvents determines, if print events for standard events (like experiment starting) should be produced. Defaults to true.

Parameters:

printStdEvents - Whether or not to print standard events.

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

Sets the Locale that is used when formatting messages. The default is Locale.US.

Parameters:

locale - The locale to use.

See Also:

Util#DEF_LOCALE

printResults

public static void printResults(@Nullable
                                Experiment e,
                                Map<String,Object> res)

Static method to prints the results res of an experiment e to System.out.

Parameters:

e - The experiment that was executed.

res - The list of results.

printResults

public static void printResults(Map<String,Object> res)

Static method to prints the results res of an experiment or Simulation to System.out.

Parameters:

res - The map of results.

printResults

public static void printResults(PrintWriter out,
                                @Nullable
                                Experiment e,
                                Map<String,Object> res)

Static method to print the results res of an experiment e to a PrintWriter.

Parameters:

out - The PrintWriter to use for printing.

e - The experiment that was executed.

res - The list of results.

printResults

public static void printResults(PrintWriter out,
                                Map<String,Object> res)

Static method to print the results res of an experiment or Simulation to a PrintWriter.

Parameters:

out - The PrintWriter to use for printing.

res - The map of results.

printEventList

public static void printEventList(PrintWriter out,
                                  Simulation sim)

Prints the current event list (including the current event) to the given PrintWriter.

printEventList

public static void printEventList(Simulation sim)

Prints the current event list (including the current event) to the console.

getDescription

public static String getDescription(Experiment e)

Returns a textual representation of an experiment's properties and their current values.

Parameters:

e - The experiment to describe.