de.binfalse.bflog

Class LOGGER

java.lang.Object

de.binfalse.bflog.LOGGER

public class LOGGER
extends Object

LOGGER is a tiny and simple logging framework. Following options are available to initialize the LOGGER:

 // set log level
 LOGGER.setMinLevel (LOGGER.WARN);
 //write to std::out?
 LOGGER.setLogToStdOut (true);
 //write to std::err? 
 LOGGER.setLogToStdErr (true);
 //write to a file?
 LOGGER.setLogFile (new File ("/my/log/file"));
 LOGGER.setLogToFile (true);
 

If you don't initialize the LOGGER it defaults to printing to only warning and error messages sdt::err. Of course all these methods can be used from wherever you want. To log a message just call one of the following functions:

LOGGER.debug ("message", [EXCEPTION])	log a debug message
LOGGER.info ("message", [EXCEPTION])	log an info message
LOGGER.warn ("message", [EXCEPTION])	log a warn message
LOGGER.error ("message", [EXCEPTION])	log an error message

Thereby, the exception parameter is optional, just in case an exception was thrown. To close the LOGGER just call LOGGER.closeLogger () in order to clean up and close the file stream.

Author:

Martin Scharm

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleDateFormat	dateformat The Constant date format that is used in log messages.
static int	DEBUG The Constant DEBUG.
static int	ERROR The Constant ERROR.
static int	INFO The Constant INFO.
protected static int	logLevel The log level, defaults to warning and error messages.
static String	NEWLINE The os independent new line char
static int	WARN The Constant WARN.

Constructor Summary

Constructors

Constructor and Description
LOGGER()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addCallback(LogCallback callBack)
static void	addLevel(int level) Adds a log level.
static void	closeLogger() Close the logger.
static void	debug(Exception e, Object... msg) Log a debug message.
static void	debug(Object... msg) Log a debug message.
static void	debug(String msg, Exception e) Deprecated. use debug(Exception e, String... msg) instead
static void	error(Exception e, Object... msg) Log an error.
static void	error(Object... msg) Log an error.
static void	error(String msg, Exception e) Deprecated. use error(Exception e, String... msg) instead
static boolean	hasLevel(int level) Checks for a log level.
static void	info(Exception e, Object... msg) Log an info message.
static void	info(Object... msg) Log an info message.
static void	info(String msg, Exception e) Deprecated. use info(Exception e, String... msg) instead
static boolean	isDebugEnabled() Checks if debug is enabled.
static boolean	isErrorEnabled() Checks if error is enabled.
static boolean	isInfoEnabled() Checks if info is enabled.
static boolean	isWarnEnabled() Checks if warn is enabled.
static void	rmCallBack(LogCallback callBack)
static void	rmLevel(int level) Removes a level.
static void	setLevel(int level) Sets the exclusive level.
static boolean	setLogFile(File file) Define the file to write the logs to.
static boolean	setLogFile(String fileName) Define the file to write the log to.
static void	setLogStackTrace(boolean log) Should we log stack traces? If you pass true you'll find a stacktrace after the log message which passed an exception, otherwise (default) only the exception class and the corresponding message will be logged.
static boolean	setLogToFile(boolean log) Should we write to the log file? Only successful if log file was defined previously.
static void	setLogToStdErr(boolean log) Should we log to std::err? default: true
static void	setLogToStdOut(boolean log) Should we log to std::out? default: false
static void	setMinLevel(int level) Sets the min log level.
static void	warn(Exception e, Object... msg) Log a warning message.
static void	warn(Object... msg) Log a warning message.
static void	warn(String msg, Exception e) Deprecated. use warn(Exception e, String... msg) instead

Methods inherited from class java.lang.Object

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

Field Detail

ERROR

public static final int ERROR

The Constant ERROR.

See Also:

Constant Field Values

WARN

public static final int WARN

The Constant WARN.

See Also:

Constant Field Values

INFO

public static final int INFO

The Constant INFO.

See Also:

Constant Field Values

DEBUG

public static final int DEBUG

The Constant DEBUG.

See Also:

Constant Field Values

dateformat

public static final SimpleDateFormat dateformat

The Constant date format that is used in log messages. Defaults to dd.MM HH:mm:ss, e.g. 27.10 18:55:49

NEWLINE

public static final String NEWLINE

The os independent new line char

logLevel

protected static int logLevel

The log level, defaults to warning and error messages.

Constructor Detail

LOGGER

public LOGGER()

Method Detail

setLogFile

public static boolean setLogFile(String fileName)

Define the file to write the log to. Does not start logging to that file, call LOGGER.setLogToFile (true) to start writing to log file. Same as LOGGER.setLogFile (new File (fileName))

Parameters:

fileName - the log file

Returns:

true, if sets the log file

setLogFile

public static boolean setLogFile(File file)

Define the file to write the logs to. Does not start logging to that file, call LOGGER.setLogToFile (true) to start writing to log file.

Parameters:

file - the log file

Returns:

true, if the log file is read- and writeable

closeLogger

public static void closeLogger()

Close the logger. Cleans up and closes the log file.

setLogToFile

public static boolean setLogToFile(boolean log)

Should we write to the log file? Only successful if log file was defined previously. (call LOGGER.setLogFile (file))

Parameters:

log - should we log to file?

Returns:

true, log file defined and stream open successfully

setLogStackTrace

public static void setLogStackTrace(boolean log)

Should we log stack traces? If you pass true you'll find a stacktrace after the log message which passed an exception, otherwise (default) only the exception class and the corresponding message will be logged.

Parameters:

log - should we log stack traces?

setLogToStdErr

public static void setLogToStdErr(boolean log)

Should we log to std::err? default: true

Parameters:

log - should we log to std:err?

setLogToStdOut

public static void setLogToStdOut(boolean log)

Should we log to std::out? default: false

Parameters:

log - the log to std out

setMinLevel

public static void setMinLevel(int level)

Sets the min log level. Available log levels in order: LOGGER.DEBUG, LOGGER.INFO, LOGGER.WARN, LOGGER.ERROR. By default the min level is LOGGER.WARN. Thus, LOGGER.setMinLevel (LOGGER.INFO) enables logging for INFO, WARN, and ERROR messages.

Parameters:

level - the min level

setLevel

public static void setLevel(int level)

Sets the exclusive level. Thus, LOGGER.setLevel (LOGGER.INFO) enables logging only for INFO messages.

Parameters:

level - the level

addLevel

public static void addLevel(int level)

Adds a log level. Thus, if previously only INFO was enabled, LOGGER.addLevel (LOGGER.ERROR) enables logging only for INFO and ERROR messages.

Parameters:

level - the level

rmLevel

public static void rmLevel(int level)

Removes a level. Thus, if previously INFO and ERROR was enabled, LOGGER.rmLevel (LOGGER.INFO) enables logging only for ERROR messages.

Parameters:

level - the level

hasLevel

public static boolean hasLevel(int level)

Checks for a log level.

Parameters:

level - the level

Returns:

true, if level is enabled

isInfoEnabled

public static boolean isInfoEnabled()

Checks if info is enabled.

Returns:

true, if info logging is enabled

isDebugEnabled

public static boolean isDebugEnabled()

Checks if debug is enabled.

Returns:

true, if debug logging is enabled

isErrorEnabled

public static boolean isErrorEnabled()

Checks if error is enabled.

Returns:

true, if error logging is enabled

isWarnEnabled

public static boolean isWarnEnabled()

Checks if warn is enabled.

Returns:

true, if warn logging is enabled

error

@Deprecated
public static void error(String msg,
                    Exception e)

Deprecated. use error(Exception e, String... msg) instead

Log an error.

Parameters:

msg - the msg

e - the thrown exception

info

@Deprecated
public static void info(String msg,
                   Exception e)

Deprecated. use info(Exception e, String... msg) instead

Log an info message.

Parameters:

msg - the msg

e - the thrown exception

debug

@Deprecated
public static void debug(String msg,
                    Exception e)

Deprecated. use debug(Exception e, String... msg) instead

Log a debug message.

Parameters:

msg - the msg

e - the thrown exception

warn

@Deprecated
public static void warn(String msg,
                   Exception e)

Deprecated. use warn(Exception e, String... msg) instead

Log a warning message.

Parameters:

msg - the msg

e - the thrown exception

error

public static void error(Exception e,
         Object... msg)

Log an error.

Parameters:

msg - the msg

e - the thrown exception

info

public static void info(Exception e,
        Object... msg)

Log an info message.

Parameters:

msg - the msg

e - the thrown exception

debug

public static void debug(Exception e,
         Object... msg)

Log a debug message.

Parameters:

msg - the msg

e - the thrown exception

warn

public static void warn(Exception e,
        Object... msg)

Log a warning message.

Parameters:

msg - the msg

e - the thrown exception

error

public static void error(Object... msg)

Log an error.

Parameters:

msg - the msg

info

public static void info(Object... msg)

Log an info message.

Parameters:

msg - the msg

debug

public static void debug(Object... msg)

Log a debug message.

Parameters:

msg - the msg

warn

public static void warn(Object... msg)

Log a warning message.

Parameters:

msg - the msg

addCallback

public static void addCallback(LogCallback callBack)

rmCallBack

public static void rmCallBack(LogCallback callBack)