de.hawhamburg.reachability.util

Class OutputUtil

java.lang.Object

de.hawhamburg.reachability.util.OutputUtil

public final class OutputUtil
extends java.lang.Object

Utility functions related to information output.

This utility class provides some fancy utility methods related to output matters (e.g. console or logfile).

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	logable An information flag which indicates if it will be possible to log messages to a file using the logger.
private static java.util.logging.Logger	logger A Logger object for logfile output.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	OutputUtil() Prevent instances of this utility class.

Method Summary

Methods

Modifier and Type	Method and Description
private static java.lang.String	buildMessage(java.lang.String msg) Builds a message from the given message.
private static void	configLogger() Sets up a logger without console output with name LOGGER_NAME.
static void	debug(java.lang.String msg) Handles a debug messages depending on the current configuration in MainConfig.
static void	endSystemWithError(java.lang.String msg) Handles the error message using handleError(String, Level).
static void	error(java.lang.String msg) Handles an error messages depending on the current configuration in MainConfig.
static void	handleError(java.lang.String msg, java.util.logging.Level lvl) Handles an error message depending on the current configuration in MainConfig.
static void	handleMessage(java.lang.String msg, java.util.logging.Level lvl) Handles an info or debug message depending on the current configuration in MainConfig.
static void	info(java.lang.String msg) Handles an info messages depending on the current configuration in MainConfig.
static void	log(java.util.logging.Level lvl, java.lang.String msg) Logs the specified message with a certain loggig Level to the logfile by using the logger, if logable is set to true.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static java.util.logging.Logger logger

A Logger object for logfile output. This object will be only set once a programs life time.

logable

private static boolean logable

An information flag which indicates if it will be possible to log messages to a file using the logger. It will be set to false if the method configLogger() is, for some reasons, unable to create the specified logfile.

Constructor Detail

OutputUtil

private OutputUtil()

Prevent instances of this utility class.

Method Detail

debug

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

Handles a debug messages depending on the current configuration in MainConfig. This method will only work if DEBUG is set to true.

If PRINT_OUTPUT is set to true, the message will printed to console (prefixed by the class name, if it isn't null).

If LOG_OUTPUT is set to true, the message will be logged to the logfile with level WARNING and the class name, if it isn't null.

Parameters:

msg - A debug message as String.

info

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

Handles an info messages depending on the current configuration in MainConfig. This method will only work if INFO is set to true.

If PRINT_OUTPUT is set to true, the message will printed to console (prefixed by the class name, if it isn't null).

If LOG_OUTPUT is set to true, the message will be logged to the logfile with level INFO and the class name, if it isn't null.

Parameters:

msg - An info message as String.

error

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

Handles an error messages depending on the current configuration in MainConfig. This method will only work if ERROR is set to true.

If PRINT_OUTPUT is set to true, the message will printed as error to console (prefixed by the class name, if it isn't null).

If LOG_OUTPUT is set to true, the message will be logged to the logfile with level SEVERE and the class name, if it isn't null.

Parameters:

msg - An error message as String.

endSystemWithError

public static void endSystemWithError(java.lang.String msg)

Handles the error message using handleError(String, Level). Sends a stop order on the LP_CONTROL_TOPIC using the JSON message JsonConfigOrder to itself to gracefully end this agent.

Parameters:

msg - An error message as String.

handleMessage

public static void handleMessage(java.lang.String msg,
                 java.util.logging.Level lvl)

Handles an info or debug message depending on the current configuration in MainConfig.

If PRINT_OUTPUT is set to true, the message will printed to console (prefixed by the class name or Unknown if it's null).

If LOG_OUTPUT is set to true, the message will be logged to the logfile with the specified Level and the class name or Unknown if it's null.

Parameters:

msg - An info or debug message as String.

lvl - A logging Level.

handleError

public static void handleError(java.lang.String msg,
               java.util.logging.Level lvl)

Handles an error message depending on the current configuration in MainConfig.

If PRINT_OUTPUT is set to true, the message will printed as error to console (prefixed by the class name or Unknown if it's null).

If LOG_OUTPUT is set to true, the message will be logged to the logfile with the specified Level and the class name or Unknown if it's null.

Parameters:

msg - An error message as String.

lvl - A logging Level.

buildMessage

private static java.lang.String buildMessage(java.lang.String msg)

Builds a message from the given message. This method determines the original method and class from which this utility class has been called and integrates them into the result message.

Parameters:

msg - A message as String.

Returns:

A String containing the originators class and method name.

log

public static void log(java.util.logging.Level lvl,
       java.lang.String msg)

Logs the specified message with a certain loggig Level to the logfile by using the logger, if logable is set to true. If no logger is configured, the method will call configLogger() to create on.

Parameters:

lvl - A logging Level.

msg - A message as String which shall be logged to the logfile.

configLogger

private static void configLogger()

Sets up a logger without console output with name LOGGER_NAME. The logger will write its logging to the logfile LOGGER_FILE which will grow up to LOGGER_MAX_FILE_SIZEs. The logging level Level.WARNING will be written as DEBUG. If it is not possible to create the logfile, the whole system will end itself controlled with console output.