ifs.fnd.log

Class Logger

java.lang.Object

ifs.fnd.log.Logger

Direct Known Subclasses:

TimingsLogger

public abstract class Logger
extends java.lang.Object

The Logger class. An instance of this class is created for each category per thread. The instances are pooled and can be reused during subsequent calls from the same thread. However a new instance of this class has to be created on log level change for the category. Methods of type error() are always enabled.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	debug
protected java.util.UUID	errorId
boolean	info
java.lang.String	name
boolean	trace
boolean	warning

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Logger(java.lang.String name, boolean warning, boolean info, boolean trace, boolean debug) Constructs new Logger instance with name corresponding to category and level defined by four flags.

Method Summary

Modifier and Type	Method and Description
void	addTag(java.lang.String name) Add a default tag to this Logger.
void	addTag(java.lang.String name, java.lang.String type) Add a default tag to this Logger.
void	addTags(Tags tags) Add a default tag collection to this Logger.
void	clearTags() Clear the default tag collection associated to this Logger.
void	debug(java.lang.String message, java.lang.Object... params)
void	debug(Tags tag, java.lang.String message, java.lang.Object... params)
void	debug(java.lang.Throwable t)
void	debug(java.lang.Throwable t, java.lang.String message, java.lang.Object... params)
void	debug(java.lang.Throwable t, Tags tag)
abstract void	debug(java.lang.Throwable t, Tags tag, java.lang.String message, java.lang.Object... params) Method for debugging.
void	debugStackTrace()
void	debugStackTrace(boolean ifsOnly)
void	error(java.lang.String message, java.lang.Object... params)
void	error(Tags tag, java.lang.String message, java.lang.Object... params)
void	error(java.lang.Throwable t)
void	error(java.lang.Throwable t, java.lang.String message, java.lang.Object... params)
void	error(java.lang.Throwable t, Tags tag)
abstract void	error(java.lang.Throwable t, Tags tag, java.lang.String message, java.lang.Object... params) Method for logging of errors.
abstract void	forward(Logger to) Forwards everything to another Logger
java.util.logging.Level	getInternalLevel() Returns instance of java.util.logging.Level representing logging level of this Logger.
abstract java.util.logging.Logger	getInternalLogger() Returns instance of java.util.logging.Logger used internally by this Logger.
java.util.UUID	getLastErrorId() Returns ID of the last error handled by this Logger.
Tags	getTags() Get default tag collection, if any, associated to this Logger.
void	info(java.lang.String message, java.lang.Object... params)
void	info(Tags tag, java.lang.String message, java.lang.Object... params)
void	info(java.lang.Throwable t)
void	info(java.lang.Throwable t, java.lang.String message, java.lang.Object... params)
void	info(java.lang.Throwable t, Tags tag)
abstract void	info(java.lang.Throwable t, Tags tag, java.lang.String message, java.lang.Object... params) Method for logging of informations.
abstract boolean	isForwarded() Checks if the current Logger is forwarded to another Logger.
void	log(java.lang.String message) Logs a message using the current log level.
abstract void	performThreadCheck(boolean performCheck) Enables/disables thread check (enabled by default).
void	removeFromStack(java.lang.Class cls) Removes the specified class from stack trace on logging event.
void	removeFromStack(java.lang.Class cls, java.lang.String methName) Removes the specified method call from stack trace on logging event.
void	removeFromStack(java.lang.String clsName) Removes the specified class from stack trace on logging event.
abstract void	removeFromStack(java.lang.String clsName, java.lang.String methName) Removes the specified method call from stack trace on logging event.
boolean	removeTag(java.lang.String name) Remove a named tag from tag collection associated to this Logger.
boolean	removeTag(java.lang.String name, java.lang.String type) Remove a named tag from tag collection associated to this Logger.
boolean	removeTags(Tags tags) Remove all tags represented by the argument from tag collection associated to this Logger.
abstract void	stopForwarding() Stops Logger forwarding
void	trace(java.lang.String message, java.lang.Object... params)
void	trace(Tags tag, java.lang.String message, java.lang.Object... params)
void	trace(java.lang.Throwable t)
void	trace(java.lang.Throwable t, java.lang.String message, java.lang.Object... params)
void	trace(java.lang.Throwable t, Tags tag)
abstract void	trace(java.lang.Throwable t, Tags tag, java.lang.String message, java.lang.Object... params) Method for tracing and light debugging.
void	warning(java.lang.String message, java.lang.Object... params)
void	warning(Tags tag, java.lang.String message, java.lang.Object... params)
void	warning(java.lang.Throwable t)
void	warning(java.lang.Throwable t, java.lang.String message, java.lang.Object... params)
void	warning(java.lang.Throwable t, Tags tag)
abstract void	warning(java.lang.Throwable t, Tags tag, java.lang.String message, java.lang.Object... params) Method for logging of warnings.

Methods inherited from class java.lang.Object

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

Field Detail

warning

public final boolean warning

info

public final boolean info

trace

public final boolean trace

debug

public final boolean debug

name

public final java.lang.String name

errorId

protected java.util.UUID errorId

Constructor Detail

Logger

protected Logger(java.lang.String name,
                 boolean warning,
                 boolean info,
                 boolean trace,
                 boolean debug)

Constructs new Logger instance with name corresponding to category and level defined by four flags. Not all flag combination are allowed (e.g. 'info' can not be false if 'trace' is true), but there is no control here; the responsibility lies on the caller.

Parameters:

name -

warning -

info -

trace -

debug -

Method Detail

error

public abstract void error(java.lang.Throwable t,
                           Tags tag,
                           java.lang.String message,
                           java.lang.Object... params)

Method for logging of errors. Always enabled; use with care.

Parameters:

t -

tag -

message -

params -

error

public final void error(java.lang.String message,
                        java.lang.Object... params)

error

public final void error(java.lang.Throwable t)

error

public final void error(java.lang.Throwable t,
                        java.lang.String message,
                        java.lang.Object... params)

error

public final void error(Tags tag,
                        java.lang.String message,
                        java.lang.Object... params)

error

public final void error(java.lang.Throwable t,
                        Tags tag)

warning

public abstract void warning(java.lang.Throwable t,
                             Tags tag,
                             java.lang.String message,
                             java.lang.Object... params)

Method for logging of warnings. Use together with the 'warning' flag, e.g. if 'log' is an instance of Logger:

    if(log.warning) log.warning("A warning message");
 

Parameters:

t -

tag -

message -

params -

warning

public final void warning(java.lang.String message,
                          java.lang.Object... params)

warning

public final void warning(java.lang.Throwable t)

warning

public final void warning(java.lang.Throwable t,
                          java.lang.String message,
                          java.lang.Object... params)

warning

public final void warning(Tags tag,
                          java.lang.String message,
                          java.lang.Object... params)

warning

public final void warning(java.lang.Throwable t,
                          Tags tag)

info

public abstract void info(java.lang.Throwable t,
                          Tags tag,
                          java.lang.String message,
                          java.lang.Object... params)

Method for logging of informations. Use together with the 'info' flag, e.g. if 'log' is an instance of Logger:

    if(log.info) log.info("An information");
 

Parameters:

t -

tag -

message -

params -

info

public final void info(java.lang.String message,
                       java.lang.Object... params)

info

public final void info(java.lang.Throwable t)

info

public final void info(java.lang.Throwable t,
                       java.lang.String message,
                       java.lang.Object... params)

info

public final void info(Tags tag,
                       java.lang.String message,
                       java.lang.Object... params)

info

public final void info(java.lang.Throwable t,
                       Tags tag)

trace

public abstract void trace(java.lang.Throwable t,
                           Tags tag,
                           java.lang.String message,
                           java.lang.Object... params)

Method for tracing and light debugging. Use together with the 'trace' flag, e.g. if 'log' is an instance of Logger:

    if(log.trace) log.trace("A trace message");
 

Parameters:

t -

tag -

message -

params -

trace

public final void trace(java.lang.String message,
                        java.lang.Object... params)

trace

public final void trace(java.lang.Throwable t)

trace

public final void trace(java.lang.Throwable t,
                        java.lang.String message,
                        java.lang.Object... params)

trace

public final void trace(Tags tag,
                        java.lang.String message,
                        java.lang.Object... params)

trace

public final void trace(java.lang.Throwable t,
                        Tags tag)

debug

public abstract void debug(java.lang.Throwable t,
                           Tags tag,
                           java.lang.String message,
                           java.lang.Object... params)

Method for debugging. Use together with the 'debug' flag, e.g. if 'log' is an instance of Logger:

    if(log.debug) log.debug("A debug message");
 

Parameters:

t -

tag -

message -

params -

debug

public final void debug(java.lang.String message,
                        java.lang.Object... params)

debug

public final void debug(java.lang.Throwable t)

debug

public final void debug(java.lang.Throwable t,
                        java.lang.String message,
                        java.lang.Object... params)

debug

public final void debug(Tags tag,
                        java.lang.String message,
                        java.lang.Object... params)

debug

public final void debug(java.lang.Throwable t,
                        Tags tag)

log

public void log(java.lang.String message)

Logs a message using the current log level. Nothing will happen if all logging flags (debug, trace, info and warning) are set to false.

Parameters:

message - message to log

debugStackTrace

public final void debugStackTrace()

debugStackTrace

public final void debugStackTrace(boolean ifsOnly)

removeFromStack

public final void removeFromStack(java.lang.Class cls)

Removes the specified class from stack trace on logging event.

Parameters:

cls -

removeFromStack

public final void removeFromStack(java.lang.Class cls,
                                  java.lang.String methName)

Removes the specified method call from stack trace on logging event.

Parameters:

cls -

methName -

removeFromStack

public final void removeFromStack(java.lang.String clsName)

Removes the specified class from stack trace on logging event.

Parameters:

clsName -

removeFromStack

public abstract void removeFromStack(java.lang.String clsName,
                                     java.lang.String methName)

Removes the specified method call from stack trace on logging event.

Parameters:

clsName -

methName -

performThreadCheck

public abstract void performThreadCheck(boolean performCheck)

Enables/disables thread check (enabled by default).

Parameters:

performCheck -

forward

public abstract void forward(Logger to)

Forwards everything to another Logger

Parameters:

to - Logger to forward to

isForwarded

public abstract boolean isForwarded()

Checks if the current Logger is forwarded to another Logger.

Returns:

true if the Logger is forwarded

stopForwarding

public abstract void stopForwarding()

Stops Logger forwarding

addTag

public void addTag(java.lang.String name)

Add a default tag to this Logger.

Parameters:

name -

addTag

public void addTag(java.lang.String name,
                   java.lang.String type)

Add a default tag to this Logger.

Parameters:

name -

type -

addTags

public void addTags(Tags tags)

Add a default tag collection to this Logger.

Parameters:

tags -

getTags

public Tags getTags()

Get default tag collection, if any, associated to this Logger.

Returns:

removeTag

public boolean removeTag(java.lang.String name)

Remove a named tag from tag collection associated to this Logger.

Parameters:

name -

Returns:

true if the collection contained the named tag

removeTag

public boolean removeTag(java.lang.String name,
                         java.lang.String type)

Remove a named tag from tag collection associated to this Logger.

Parameters:

name -

type -

Returns:

true if the collection contained the named tag

removeTags

public boolean removeTags(Tags tags)

Remove all tags represented by the argument from tag collection associated to this Logger.

Parameters:

tags -

Returns:

true if the collection contained all the tags

clearTags

public void clearTags()

Clear the default tag collection associated to this Logger.

getLastErrorId

public final java.util.UUID getLastErrorId()

Returns ID of the last error handled by this Logger.

Returns:

getInternalLogger

public abstract java.util.logging.Logger getInternalLogger()

Returns instance of java.util.logging.Logger used internally by this Logger.

Returns:

getInternalLevel

public java.util.logging.Level getInternalLevel()

Returns instance of java.util.logging.Level representing logging level of this Logger.

Returns: