esa.opensf.osfi

Class Logger

java.lang.Object

esa.opensf.osfi.Logger

public final class Logger
extends java.lang.Object

Logger.
Manages the log messages raised.

Method Summary

Modifier and Type	Method and Description
static void	debug(java.lang.String message) Shows a formatted debug message, if the environment variable "DEBUG_MODE" is equal to "On".
static void	error(java.lang.String message) Shows a formatted error message.
static void	finishExecution(int errorCode) Shows an information message and exits the program execution with an specific error code.
static void	info(java.lang.String message) Shows a formatted information message.
static boolean	isColored() Checks if the system is in color mode.
static boolean	isDebugging() Checks if the system is in debug mode.
static void	printMessage(java.lang.String logType, java.lang.String message, java.lang.String fg, java.lang.String bg) Deprecated. Internal function, to be removed from public API
static void	progress(int step, int nSteps) Shows a formatted progress message.
static void	qualityReport(java.lang.String name, double value) Shows a formatted message reporting a quality indicator.
static void	qualityReport(java.lang.String name, java.lang.String value) Shows a formatted message reporting a quality indicator.
static void	warning(java.lang.String message) Shows a formatted warning message.

Methods inherited from class java.lang.Object

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

Method Detail

isDebugging

public static boolean isDebugging()

Checks if the system is in debug mode.

isColored

public static boolean isColored()

Checks if the system is in color mode. OSFI_LOG_COLOR if ON the OSFI logs are colored. - Error : Red - Warning: Yellow - Progress: Cyan - Info: Green

error

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

Shows a formatted error message.

Parameters:

message - - text of the message

warning

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

Shows a formatted warning message.

Parameters:

message - - text of the message

info

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

Shows a formatted information message.

Parameters:

message - - text of the message

debug

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

Shows a formatted debug message, if the environment variable "DEBUG_MODE" is equal to "On". First time this function is called, checks the declaration of that variable. If it is not declared, presents a warning message and assumes it as "Off".

Parameters:

message - - text of the message

progress

public static void progress(int step,
                            int nSteps)

Shows a formatted progress message.

Parameters:

step - - current step number

nSteps - - maximum number of steps.

finishExecution

public static void finishExecution(int errorCode)

Shows an information message and exits the program execution with an specific error code.

Parameters:

errorCode - - Code of error to exit with.

qualityReport

public static void qualityReport(java.lang.String name,
                                 double value)

Shows a formatted message reporting a quality indicator.

Parameters:

name - - Name of the quality indicator

value - - Double associated to the quality indicator pointed by name

qualityReport

public static void qualityReport(java.lang.String name,
                                 java.lang.String value)

Shows a formatted message reporting a quality indicator.

Parameters:

name - - Name of the quality indicator

value - - String associated to the quality indicator pointed by name

printMessage

@Deprecated
public static void printMessage(java.lang.String logType,
                                            java.lang.String message,
                                            java.lang.String fg,
                                            java.lang.String bg)

Deprecated. Internal function, to be removed from public API

Shows a formatted information message of the given log type.

Parameters:

logType -

message -