Package lumis.util.log

Interface ILogger

All Known Implementing Classes:

Log4JLoggerWrapper

@StableMinor(version="14.1",
             sinceVersion="4.0")
public interface ILogger

The logging interface, that specifies the methods available for logging.

The six logging levels are (in order):

1. debug (the least serious)
2. info
3. warn
4. error
5. fatal (the most serious)

Performance is often a logging concern. By examining the appropriate property, a component can avoid expensive operations (producing information to be logged).

For example,

    if (log.isDebugEnabled()) 
    {
        ... do something expensive ...
        log.debug(theResult);
    }
 

Since:

4.0.0

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

See Also:

LoggerFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ILogger.Level	The logging levels available in the logging system.

Method Summary

Modifier and Type	Method	Description
void	debug(Object message)	Log a message with debug log level.
void	debug(Object message, Throwable t)	Log an error with debug log level.
void	error(Object message)	Log a message with error log level.
void	error(Object message, Throwable t)	Log an error with error log level.
void	fatal(Object message)	Log a message with fatal log level.
void	fatal(Object message, Throwable t)	Log an error with fatal log level.
ILogger.Level	getLevel()	Returns the current minimum logging level logged by this instance.
void	info(Object message)	Log a message with info log level.
void	info(Object message, Throwable t)	Log an error with info log level.
boolean	isDebugEnabled()	Is debug logging currently enabled?
boolean	isErrorEnabled()	Is error logging currently enabled?
boolean	isFatalEnabled()	Is fatal logging currently enabled?
boolean	isInfoEnabled()	Is info logging currently enabled?
boolean	isWarnEnabled()	Is warn logging currently enabled?
void	setLevel(ILogger.Level level)	Sets the minimum logging level logged by this logger instance.
void	warn(Object message)	Log a message with warn log level.
void	warn(Object message, Throwable t)	Log an error with warn log level.

Method Detail

isDebugEnabled

boolean isDebugEnabled()

Is debug logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than debug.

isErrorEnabled

boolean isErrorEnabled()

Is error logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than error.

isFatalEnabled

boolean isFatalEnabled()

Is fatal logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than fatal.

isInfoEnabled

boolean isInfoEnabled()

Is info logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than info.

isWarnEnabled

boolean isWarnEnabled()

Is warn logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than warn.

debug

void debug(Object message)

Log a message with debug log level.

Parameters:

message - log this message

debug

void debug(Object message,
           Throwable t)

Log an error with debug log level.

Parameters:

message - log this message

t - log this cause

info

void info(Object message)

Log a message with info log level.

Parameters:

message - log this message

info

void info(Object message,
          Throwable t)

Log an error with info log level.

Parameters:

message - log this message

t - log this cause

warn

void warn(Object message)

Log a message with warn log level.

Parameters:

message - log this message

warn

void warn(Object message,
          Throwable t)

Log an error with warn log level.

Parameters:

message - log this message

t - log this cause

error

void error(Object message)

Log a message with error log level.

Parameters:

message - log this message

error

void error(Object message,
           Throwable t)

Log an error with error log level.

Parameters:

message - log this message

t - log this cause

fatal

void fatal(Object message)

Log a message with fatal log level.

Parameters:

message - log this message

fatal

void fatal(Object message,
           Throwable t)

Log an error with fatal log level.

Parameters:

message - log this message

t - log this cause

getLevel

ILogger.Level getLevel()

Returns the current minimum logging level logged by this instance.

setLevel

void setLevel(ILogger.Level level)

Sets the minimum logging level logged by this logger instance.

Parameters:

level - the priority level.