fiji.plugin.trackmate

Class Logger

java.lang.Object

java.io.Writer

java.io.PrintWriter

fiji.plugin.trackmate.Logger

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

Logger.SlaveLogger, Logger.StringBuilderLogger, LogRecorder

public abstract class Logger
extends PrintWriter

This class is used to log messages occurring during TrackMate execution.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.SlaveLogger A logger that wraps a master logger and uses it to echo any received message.
static class	Logger.StringBuilderLogger This Logger outputs to a StringBuilder given at construction.

Field Summary

Fields

Modifier and Type	Field and Description
static Color	BLUE_COLOR
static Logger	DEFAULT_LOGGER This Logger simply outputs to the standard output and standard error.
static Color	ERROR_COLOR
static Color	GREEN_COLOR
static Logger	IJ_LOGGER This Logger outputs to the ImageJ log window, and to the ImageJ toolbar to report progress.
static Logger	IJTOOLBAR_LOGGER This Logger outputs everything to the ImageJ toolbar.
static Color	NORMAL_COLOR
static Logger	VOID_LOGGER This logger discard any message.

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
Logger()

Method Summary

Modifier and Type	Method and Description
abstract void	error(String message) Send the message to the error channel of this logger.
void	log(String message) Append the message to the logger with default black color.
abstract void	log(String message, Color color) Append the message to the logger, with the specified color.
abstract void	setProgress(double val) Set the progress value of the process logged by this logger.
abstract void	setStatus(String status) Set the status to be displayed by this logger.

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL_COLOR

public static final Color NORMAL_COLOR

ERROR_COLOR

public static final Color ERROR_COLOR

GREEN_COLOR

public static final Color GREEN_COLOR

BLUE_COLOR

public static final Color BLUE_COLOR

VOID_LOGGER

public static final Logger VOID_LOGGER

This logger discard any message.

DEFAULT_LOGGER

public static Logger DEFAULT_LOGGER

This Logger simply outputs to the standard output and standard error. The setProgress(double) method is ignored, the setStatus(String) is sent to the console.

IJ_LOGGER

public static final Logger IJ_LOGGER

This Logger outputs to the ImageJ log window, and to the ImageJ toolbar to report progress. Colors are ignored.

IJTOOLBAR_LOGGER

public static final Logger IJTOOLBAR_LOGGER

This Logger outputs everything to the ImageJ toolbar. This is not optimal for long messages. Colors are ignored.

Constructor Detail

Logger

public Logger()

Method Detail

log

public abstract void log(String message,
                         Color color)

Append the message to the logger, with the specified color.

Parameters:

message - the message to append.

color - the color to use.

error

public abstract void error(String message)

Send the message to the error channel of this logger.

Parameters:

message - the message to send.

log

public void log(String message)

Append the message to the logger with default black color.

Parameters:

message - the message to append.

setProgress

public abstract void setProgress(double val)

Set the progress value of the process logged by this logger. Values should be between 0 and 1, 1 meaning the process if finished.

Parameters:

val - the progress value (double from 0 to 1).

setStatus

public abstract void setStatus(String status)

Set the status to be displayed by this logger.

Parameters:

status - the status to display.