de.must.io

Class Logger

java.lang.Object

de.must.io.Logger

public class Logger
extends java.lang.Object

Logger - an adapter to any logger you wish, e.g. log4j. Why don't we use log4j directly? In some cases it might be pretty oversized if we have to deploy all stuff needed by log4j. With this adapter class we may activate log4j or other logging tools without touching the entire application. Sample line of debug definition text file: de user=someone

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Logger.ErrorInformation Error information to be dispatched to error listeners.
static interface	Logger.ErrorListener A listener for error information.
static interface	Logger.Watcher

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOGGING_TYPE_LOG4J
static int	LOGGING_TYPE_SIMPLE

Constructor Summary

Constructors

Constructor and Description
Logger() Constructs a default logger.

Method Summary

Modifier and Type	Method and Description
static void	addDebug(java.lang.String debugItem)
void	addErrorListener(Logger.ErrorListener errorListener) Adds an error listener to the logger class.
void	closeLoggingFile()
void	debug(java.lang.Class<?> sender, java.lang.Object object) Logs a message as a debug information.
void	error(java.lang.Class<?> sender, java.lang.Object object) Logs a message as an error.
void	error(java.lang.Class<?> sender, java.lang.Object object, java.lang.Throwable throwable) Logs a message as an error.
void	error(java.lang.Class<?> sender, java.lang.Throwable throwable) Logs an exception as an error.
void	error(java.lang.Object object) Logs a message as an error.
void	error(java.lang.Object object, java.lang.Throwable throwable) Logs a message as an error.
void	error(java.lang.Throwable throwable) Logs an exception as an error.
protected void	finalize()
static void	forceDebug() Forces application to debug in any case, no matter if there are debug file entries or not.
static Logger	getInstance() Returns the default instance of the Logger.
java.lang.String[]	getLastDebugs()
static int	getLoggingType() Returns the logging type
void	info(java.lang.Class<?> sender, java.lang.Object object) Logs a message as information.
void	info(java.lang.Object object) Logs a message as information.
boolean	isDebugged(java.lang.Class<?> regardedClass) Returns true if regarded class is in debug mode.
boolean	isOpened() Returns true of logging file stream has already been opened.
static void	removeDebug(java.lang.String debugItem)
void	setAdditionalOutBuffer(java.util.Vector<java.lang.String> additionalOutBuffer) Sets an additional out buffer for individual presentation issues.
void	setAdditionalOutBuffer(java.util.Vector<java.lang.String> additionalOutBuffer, int additionalBufferLimit) Sets an additional out buffer for individual presentation issues.
void	setBypassAdditionalOutBuffer(boolean bypassAdditionalOutBuffer) Sets the flag to bypass additional out buffers.
void	setBypassErrorListeners(boolean bypassErrorListeners) Sets the flag to bypass error listeners.
static void	setDebugFilePath(java.lang.String debugFilePath)
void	setDurationWatch(boolean durationWatch) Set on or off watcher for long duration between two debug calls.
void	setDurationWatch(boolean durationWatch, int maxDuration) Set on or off watcher for long duration between two debug calls.
static void	setLoggingFilePath(java.io.File loggingFile, java.lang.String initialInfo) Causes output to log file as specified (LOGGING_TYPE_SIMPLE).
static void	setLoggingFilePath(java.lang.String loggingFilePath, boolean append, java.lang.String initialInfo) Causes output to log file as specified (LOGGING_TYPE_SIMPLE).
static void	setLoggingFilePath(java.lang.String loggingFilePath, java.lang.String initialInfo) Causes output to log file as specified (LOGGING_TYPE_SIMPLE).
static void	setLoggingType(int newLoggingType) Sets the logging type
void	setWatcher(Logger.Watcher watcher)
void	warn(java.lang.Class<?> sender, java.lang.Object object) Logs a message as warning.
void	warnIfDebugged(java.lang.Class<?> sender, java.lang.Object object) Warns (including stack trace) if debugged or adds message to context buffer if not.
void	writeStacktraceIfDebugged(java.lang.Class<?> regardedClass) Writes stack trace if regarded this is in debug mode.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGING_TYPE_SIMPLE

public static final int LOGGING_TYPE_SIMPLE

See Also:

Constant Field Values

LOGGING_TYPE_LOG4J

public static final int LOGGING_TYPE_LOG4J

See Also:

Constant Field Values

Constructor Detail

Logger

public Logger()

Constructs a default logger.

Method Detail

getLoggingType

public static int getLoggingType()

Returns the logging type

Returns:

the logging type

See Also:

LOGGING_TYPE_SIMPLE, LOGGING_TYPE_LOG4J

setLoggingType

public static void setLoggingType(int newLoggingType)

Sets the logging type

Parameters:

newLoggingType - the logging type

See Also:

LOGGING_TYPE_SIMPLE, LOGGING_TYPE_LOG4J

setDebugFilePath

public static void setDebugFilePath(java.lang.String debugFilePath)

setLoggingFilePath

public static void setLoggingFilePath(java.io.File loggingFile,
                                      java.lang.String initialInfo)

Causes output to log file as specified (LOGGING_TYPE_SIMPLE).

Parameters:

loggingFilePath - the path to the log file to use

initialInfo - the initial info to write into the log file

setLoggingFilePath

public static void setLoggingFilePath(java.lang.String loggingFilePath,
                                      java.lang.String initialInfo)

Causes output to log file as specified (LOGGING_TYPE_SIMPLE).

Parameters:

loggingFilePath - the path to the log file to use

initialInfo - the initial info to write into the log file

setLoggingFilePath

public static void setLoggingFilePath(java.lang.String loggingFilePath,
                                      boolean append,
                                      java.lang.String initialInfo)

Causes output to log file as specified (LOGGING_TYPE_SIMPLE).

Parameters:

loggingFilePath - the path to the log file to use

append - if true, then bytes will be written to the end of the file rather than the beginning

initialInfo - the initial info to write into the log file

addDebug

public static void addDebug(java.lang.String debugItem)

removeDebug

public static void removeDebug(java.lang.String debugItem)

forceDebug

public static void forceDebug()

Forces application to debug in any case, no matter if there are debug file entries or not.

getInstance

public static final Logger getInstance()

Returns the default instance of the Logger.

Returns:

the default instance of the Logger

isOpened

public boolean isOpened()

Returns true of logging file stream has already been opened.

Returns:

true of logging file stream has already been opened

setDurationWatch

public void setDurationWatch(boolean durationWatch)

Set on or off watcher for long duration between two debug calls. Be advised to switch on duration watch for user-dialog-free sequences only!

Parameters:

durationWatch - whether or not long duration is to be watched

setDurationWatch

public void setDurationWatch(boolean durationWatch,
                             int maxDuration)

Set on or off watcher for long duration between two debug calls.

Parameters:

durationWatch - whether or not long duration is to be watched

maxDurationthe - duration maximum (milliseconds) to prevent from output

addErrorListener

public void addErrorListener(Logger.ErrorListener errorListener)

Adds an error listener to the logger class.

Parameters:

errorListener - the error listener to add

setWatcher

public void setWatcher(Logger.Watcher watcher)

setAdditionalOutBuffer

public void setAdditionalOutBuffer(java.util.Vector<java.lang.String> additionalOutBuffer)

Sets an additional out buffer for individual presentation issues.

Parameters:

additionalOutBuffer - the additional out buffer to be informed.

setAdditionalOutBuffer

public void setAdditionalOutBuffer(java.util.Vector<java.lang.String> additionalOutBuffer,
                                   int additionalBufferLimit)

Sets an additional out buffer for individual presentation issues.

Parameters:

additionalOutBuffer - the additional out buffer to be informed.

additionalBufferLimit - the limitation buffer extension in order to avoid OutOfMemoryExceptions

setBypassAdditionalOutBuffer

public void setBypassAdditionalOutBuffer(boolean bypassAdditionalOutBuffer)

Sets the flag to bypass additional out buffers. Out buffers will not be written while flag is set.

Parameters:

bypassAdditionalOutBuffer - whether or not additional out buffers are to be bypassed.

setBypassErrorListeners

public void setBypassErrorListeners(boolean bypassErrorListeners)

Sets the flag to bypass error listeners. Listeners will not be informed about errors while flag is set.

Parameters:

bypassErrorListeners - whether or not error listeners are to be bypassed.

info

public void info(java.lang.Object object)

Logs a message as information.

Parameters:

object - the message (text) to log

info

public void info(java.lang.Class<?> sender,
                 java.lang.Object object)

Logs a message as information.

Parameters:

sender - the message sending class

object - the message (text) to log

warnIfDebugged

public void warnIfDebugged(java.lang.Class<?> sender,
                           java.lang.Object object)

Warns (including stack trace) if debugged or adds message to context buffer if not.

Parameters:

sender - the message sending class

object - the message (text) to log

warn

public void warn(java.lang.Class<?> sender,
                 java.lang.Object object)

Logs a message as warning.

Parameters:

sender - the message sending class

object - the message (text) to log

error

public void error(java.lang.Object object)

Logs a message as an error.

Parameters:

object - the message (text) to log

error

public void error(java.lang.Throwable throwable)

Logs an exception as an error.

Parameters:

throwable - the exception to log

error

public void error(java.lang.Class<?> sender,
                  java.lang.Throwable throwable)

Logs an exception as an error.

Parameters:

sender - the message sending class

throwable - the exception to log

error

public void error(java.lang.Object object,
                  java.lang.Throwable throwable)

Logs a message as an error.

Parameters:

object - the message (text) to log

throwable - the exception to log

error

public void error(java.lang.Class<?> sender,
                  java.lang.Object object)

Logs a message as an error.

Parameters:

sender - the message sending class

object - the message (text) to log

error

public void error(java.lang.Class<?> sender,
                  java.lang.Object object,
                  java.lang.Throwable throwable)

Logs a message as an error.

Parameters:

sender - the message sending class

object - the message (text) to log

throwable - the exception to log

debug

public void debug(java.lang.Class<?> sender,
                  java.lang.Object object)

Logs a message as a debug information.

Parameters:

sender - the message sending class

object - the message (text) to log

writeStacktraceIfDebugged

public void writeStacktraceIfDebugged(java.lang.Class<?> regardedClass)

Writes stack trace if regarded this is in debug mode. Excellent way to find out the reason for unexpected behavior, especially in server context. Sample: Logger.getInstance().writeStacktraceIfDebugged(getClass());

Parameters:

regardedClass - the regarded class

isDebugged

public boolean isDebugged(java.lang.Class<?> regardedClass)

Returns true if regarded class is in debug mode.

Parameters:

regardedClass - the regarded class

Returns:

true if regarded class is in debug mode

getLastDebugs

public java.lang.String[] getLastDebugs()

closeLoggingFile

public void closeLoggingFile()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable