pl.project13.core.log

Interface LoggerBridge

All Known Implementing Classes:

StdOutLoggerBridge

public interface LoggerBridge

Interface for logging in git-commit-id plugin. Isolates logging to enable future possible code reuse in other tools. Adds verbosity flag. Given SLF4J popularity and recent internal Maven adoption, follows SLF4J interfaces.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String msg) Log a message at the DEBUG level.
void	debug(java.lang.String format, java.lang.Object... arguments) Log a message at the DEBUG level according to the specified format and arguments.
void	debug(java.lang.String format, java.lang.Object arg) Log a message at the DEBUG level according to the specified format and argument.
void	debug(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a message at the DEBUG level according to the specified format and arguments.
void	debug(java.lang.String msg, java.lang.Throwable t) Log an exception (throwable) at the DEBUG level with an accompanying message.
void	error(java.lang.String msg) Log a message at the ERROR level.
void	error(java.lang.String format, java.lang.Object... arguments) Log a message at the ERROR level according to the specified format and arguments.
void	error(java.lang.String format, java.lang.Object arg) Log a message at the ERROR level according to the specified format and argument.
void	error(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a message at the ERROR level according to the specified format and arguments.
void	error(java.lang.String msg, java.lang.Throwable t) Log an exception (throwable) at the ERROR level with an accompanying message.
void	info(java.lang.String msg) Log a message at the INFO level.
void	info(java.lang.String format, java.lang.Object... arguments) Log a message at the INFO level according to the specified format and arguments.
void	info(java.lang.String format, java.lang.Object arg) Log a message at the INFO level according to the specified format and argument.
void	info(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a message at the INFO level according to the specified format and arguments.
void	info(java.lang.String msg, java.lang.Throwable t) Log an exception (throwable) at the INFO level with an accompanying message.
boolean	isDebugEnabled() Is the logger instance enabled for the DEBUG level?
boolean	isErrorEnabled() Is the logger instance enabled for the ERROR level?
boolean	isInfoEnabled() Is the logger instance enabled for the INFO level?
boolean	isVerbose() Returns true if plugin does verbose logging.
boolean	isWarnEnabled() Is the logger instance enabled for the WARN level?
void	setVerbose(boolean verbose) Sets plugin to verbose mode.
void	warn(java.lang.String msg) Log a message at the WARN level.
void	warn(java.lang.String format, java.lang.Object... arguments) Log a message at the WARN level according to the specified format and arguments.
void	warn(java.lang.String format, java.lang.Object arg) Log a message at the WARN level according to the specified format and argument.
void	warn(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a message at the WARN level according to the specified format and arguments.
void	warn(java.lang.String msg, java.lang.Throwable t) Log an exception (throwable) at the WARN level with an accompanying message.

Method Detail

isVerbose

boolean isVerbose()

Returns true if plugin does verbose logging.

Returns:

true if plugin does verbose logging

setVerbose

void setVerbose(boolean verbose)

Sets plugin to verbose mode.

Parameters:

verbose - plugin verbosity flag

isDebugEnabled

boolean isDebugEnabled()

Is the logger instance enabled for the DEBUG level?

Returns:

True if this Logger is enabled for the DEBUG level, false otherwise.

debug

void debug(java.lang.String msg)

Log a message at the DEBUG level.

Parameters:

msg - the message string to be logged

debug

void debug(java.lang.String format,
           java.lang.Object arg)

Log a message at the DEBUG level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the DEBUG level.

Parameters:

format - the format string

arg - the argument

debug

void debug(java.lang.String format,
           java.lang.Object arg1,
           java.lang.Object arg2)

Log a message at the DEBUG level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the DEBUG level.

Parameters:

format - the format string

arg1 - the first argument

arg2 - the second argument

debug

void debug(java.lang.String format,
           java.lang.Object... arguments)

Log a message at the DEBUG level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the DEBUG level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for DEBUG. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

debug

void debug(java.lang.String msg,
           java.lang.Throwable t)

Log an exception (throwable) at the DEBUG level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

isInfoEnabled

boolean isInfoEnabled()

Is the logger instance enabled for the INFO level?

Returns:

True if this Logger is enabled for the INFO level, false otherwise.

info

void info(java.lang.String msg)

Log a message at the INFO level.

Parameters:

msg - the message string to be logged

info

void info(java.lang.String format,
          java.lang.Object arg)

Log a message at the INFO level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the INFO level.

Parameters:

format - the format string

arg - the argument

info

void info(java.lang.String format,
          java.lang.Object arg1,
          java.lang.Object arg2)

Log a message at the INFO level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the INFO level.

Parameters:

format - the format string

arg1 - the first argument

arg2 - the second argument

info

void info(java.lang.String format,
          java.lang.Object... arguments)

Log a message at the INFO level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the INFO level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for INFO. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

info

void info(java.lang.String msg,
          java.lang.Throwable t)

Log an exception (throwable) at the INFO level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

isWarnEnabled

boolean isWarnEnabled()

Is the logger instance enabled for the WARN level?

Returns:

True if this Logger is enabled for the WARN level, false otherwise.

warn

void warn(java.lang.String msg)

Log a message at the WARN level.

Parameters:

msg - the message string to be logged

warn

void warn(java.lang.String format,
          java.lang.Object arg)

Log a message at the WARN level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the WARN level.

Parameters:

format - the format string

arg - the argument

warn

void warn(java.lang.String format,
          java.lang.Object arg1,
          java.lang.Object arg2)

Log a message at the WARN level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the WARN level.

Parameters:

format - the format string

arg1 - the first argument

arg2 - the second argument

warn

void warn(java.lang.String format,
          java.lang.Object... arguments)

Log a message at the WARN level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the WARN level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for WARN. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

warn

void warn(java.lang.String msg,
          java.lang.Throwable t)

Log an exception (throwable) at the WARN level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

isErrorEnabled

boolean isErrorEnabled()

Is the logger instance enabled for the ERROR level?

Returns:

True if this Logger is enabled for the ERROR level, false otherwise.

error

void error(java.lang.String msg)

Log a message at the ERROR level.

Parameters:

msg - the message string to be logged

error

void error(java.lang.String format,
           java.lang.Object arg)

Log a message at the ERROR level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the ERROR level.

Parameters:

format - the format string

arg - the argument

error

void error(java.lang.String format,
           java.lang.Object arg1,
           java.lang.Object arg2)

Log a message at the ERROR level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the ERROR level.

Parameters:

format - the format string

arg1 - the first argument

arg2 - the second argument

error

void error(java.lang.String format,
           java.lang.Object... arguments)

Log a message at the ERROR level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the ERROR level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for ERROR. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

error

void error(java.lang.String msg,
           java.lang.Throwable t)

Log an exception (throwable) at the ERROR level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log