Package org.pipservices3.components.log

Class NullLogger

java.lang.Object

org.pipservices3.components.log.NullLogger

All Implemented Interfaces:

ILogger

public class NullLogger
extends Object
implements ILogger

Dummy implementation of logger that doesn't do anything.

It can be used in testing or in situations when logger is required but shall be disabled.

See Also:

ILogger

Constructor Summary

Constructors

Constructor	Description
NullLogger()	Creates a new instance of the logger.

Method Summary

Modifier and Type	Method	Description
void	debug(String correlationId, String message, Object... args)	Logs a high-level debug information for troubleshooting.
void	error(String correlationId, Exception error)	Logs recoverable application error.
void	error(String correlationId, Exception error, String message, Object... args)	Logs recoverable application error.
void	error(String correlationId, String message, Object... args)	Logs recoverable application error.
void	fatal(String correlationId, Exception error)	Logs fatal (unrecoverable) message that caused the process to crash.
void	fatal(String correlationId, Exception error, String message, Object... args)	Logs fatal (unrecoverable) message that caused the process to crash.
void	fatal(String correlationId, String message, Object... args)	Logs fatal (unrecoverable) message that caused the process to crash.
LogLevel	getLevel()	Gets the maximum log level.
void	info(String correlationId, String message, Object... args)	Logs an important information message
void	log(LogLevel level, String correlationId, Exception error, String message, Object... args)	Logs a message at specified log level.
void	setLevel(LogLevel value)	Set the maximum log level.
void	trace(String correlationId, String message, Object... args)	Logs a low-level debug information for troubleshooting.
void	warn(String correlationId, String message, Object... args)	Logs a warning that may or may not have a negative impact.

Methods inherited from class java.lang.Object

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

Constructor Details

NullLogger

public NullLogger()

Creates a new instance of the logger.

Method Details

getLevel

public LogLevel getLevel()

Gets the maximum log level. Messages with higher log level are filtered out.

Specified by:

getLevel in interface ILogger

Returns:

the maximum log level.

setLevel

public void setLevel(LogLevel value)

Set the maximum log level.

Specified by:

setLevel in interface ILogger

Parameters:

value - a new maximum log level.

log

public void log(LogLevel level,
String correlationId,
Exception error,
String message,
Object... args)

Logs a message at specified log level.

Specified by:

log in interface ILogger

Parameters:

level - a log level.

correlationId - (optional) transaction id to trace execution through call chain.

error - an error object associated with this message.

message - a human-readable message to log.

args - arguments to parameterize the message.

fatal

public void fatal(String correlationId,
String message,
Object... args)

Logs fatal (unrecoverable) message that caused the process to crash.

Specified by:

fatal in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

message - a human-readable message to log.

args - arguments to parameterize the message.

fatal

public void fatal(String correlationId,
Exception error)

Logs fatal (unrecoverable) message that caused the process to crash.

Specified by:

fatal in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

error - an error object associated with this message.

fatal

public void fatal(String correlationId,
Exception error,
String message,
Object... args)

Logs fatal (unrecoverable) message that caused the process to crash.

Specified by:

fatal in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

error - an error object associated with this message.

message - a human-readable message to log.

args - arguments to parameterize the message.

error

public void error(String correlationId,
String message,
Object... args)

Logs recoverable application error.

Specified by:

error in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

message - a human-readable message to log.

args - arguments to parameterize the message.

error

public void error(String correlationId,
Exception error)

Logs recoverable application error.

Specified by:

error in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

error - an error object associated with this message.

error

public void error(String correlationId,
Exception error,
String message,
Object... args)

Logs recoverable application error.

Specified by:

error in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

error - an error object associated with this message.

message - a human-readable message to log.

args - arguments to parameterize the message.

warn

public void warn(String correlationId,
String message,
Object... args)

Logs a warning that may or may not have a negative impact.

Specified by:

warn in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

message - a human-readable message to log.

args - arguments to parameterize the message.

info

public void info(String correlationId,
String message,
Object... args)

Logs an important information message

Specified by:

info in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

message - a human-readable message to log.

args - arguments to parameterize the message.

debug

public void debug(String correlationId,
String message,
Object... args)

Logs a high-level debug information for troubleshooting.

Specified by:

debug in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

message - a human-readable message to log.

args - arguments to parameterize the message.

trace

public void trace(String correlationId,
String message,
Object... args)

Logs a low-level debug information for troubleshooting.

Specified by:

trace in interface ILogger

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

message - a human-readable message to log.

args - arguments to parameterize the message.