com.atlassian.bamboo.specs.util

Class Logger

java.lang.Object

com.atlassian.bamboo.specs.util.Logger

public final class Logger
extends Object

Simple utility for logging to System.out at various log levels. Logging level is controlled by a system property LOG_LEVEL_PROPERTY.

See Also:

LOG_LEVEL_PROPERTY, Logger.LogLevel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Logger.LogLevel Available levels of logging.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_HIDE_DATE Name of system property which will indicate if date should be hidden in the log.
static Logger.LogLevel	LOG_LEVEL Current log level.
static String	LOG_LEVEL_PROPERTY Name of system property which will indicate logging level.

Method Summary

Modifier and Type	Method and Description
void	debug(String message, Object... args) Logs the given message at Logger.LogLevel.DEBUG level.
void	debug(Throwable throwable) Logs the given throwable at Logger.LogLevel.DEBUG level.
void	debug(Throwable throwable, String message, Object... args) Logs the given throwable and message at Logger.LogLevel.DEBUG level.
static Logger	getLogger(Class<?> forClass) Returns an instance of the logger for the given class.
void	info(String message, Object... args) Logs the given message at Logger.LogLevel.INFO level.
void	info(Throwable throwable) Logs the given throwable at Logger.LogLevel.INFO level.
void	info(Throwable throwable, String message, Object... args) Logs the given throwable and message at Logger.LogLevel.INFO level.
boolean	isDebugEnabled() Returns true if logging at Logger.LogLevel.DEBUG is enabled.
boolean	isInfoEnabled() Returns true if logging at Logger.LogLevel.INFO is enabled.
boolean	isTraceEnabled() Returns true if logging at Logger.LogLevel.TRACE is enabled.
void	log(Logger.LogLevel logLevel, String message, Object... args) Logs the given message at logLevel.
void	log(Logger.LogLevel logLevel, Throwable throwable) Logs the given throwable at logLevel level.
void	log(Logger.LogLevel logLevel, Throwable throwable, String message, Object... args) Logs the given throwable and message at logLevel.
void	trace(String message, Object... args) Logs the given message at Logger.LogLevel.TRACE level.
void	trace(Throwable throwable) Logs the given throwable at Logger.LogLevel.TRACE level.
void	trace(Throwable throwable, String message, Object... args) Logs the given throwable and message at Logger.LogLevel.TRACE level.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_LEVEL_PROPERTY

public static final String LOG_LEVEL_PROPERTY

Name of system property which will indicate logging level. The value should be set to one of the values of Logger.LogLevel enum (case insensitive).

Usage example:

 java -Dbamboo.specs.log.level=DEBUG ...

See Also:

Constant Field Values

LOG_HIDE_DATE

public static final String LOG_HIDE_DATE

Name of system property which will indicate if date should be hidden in the log. Default is false.

Usage example:

 java -Dbamboo.specs.log.hideDate=true ...

See Also:

Constant Field Values

LOG_LEVEL

public static final Logger.LogLevel LOG_LEVEL

Current log level.

Method Detail

getLogger

@NotNull
public static Logger getLogger(@NotNull
                                        Class<?> forClass)

Returns an instance of the logger for the given class.

info

public void info(@NotNull
                 String message,
                 @NotNull
                 Object... args)

Logs the given message at Logger.LogLevel.INFO level. The message is formatted using String.format(String, Object...).

info

public void info(@NotNull
                 Throwable throwable)

Logs the given throwable at Logger.LogLevel.INFO level.

info

public void info(@NotNull
                 Throwable throwable,
                 @NotNull
                 String message,
                 @NotNull
                 Object... args)

Logs the given throwable and message at Logger.LogLevel.INFO level. The message is formatted using String.format(String, Object...).

debug

public void debug(@NotNull
                  String message,
                  @NotNull
                  Object... args)

Logs the given message at Logger.LogLevel.DEBUG level. The message is formatted using String.format(String, Object...).

debug

public void debug(@NotNull
                  Throwable throwable)

Logs the given throwable at Logger.LogLevel.DEBUG level.

debug

public void debug(@NotNull
                  Throwable throwable,
                  @NotNull
                  String message,
                  @NotNull
                  Object... args)

Logs the given throwable and message at Logger.LogLevel.DEBUG level. The message is formatted using String.format(String, Object...).

trace

public void trace(@NotNull
                  String message,
                  @NotNull
                  Object... args)

Logs the given message at Logger.LogLevel.TRACE level. The message is formatted using String.format(String, Object...).

trace

public void trace(@NotNull
                  Throwable throwable)

Logs the given throwable at Logger.LogLevel.TRACE level.

trace

public void trace(@NotNull
                  Throwable throwable,
                  @NotNull
                  String message,
                  @NotNull
                  Object... args)

Logs the given throwable and message at Logger.LogLevel.TRACE level. The message is formatted using String.format(String, Object...).

log

public void log(@NotNull
                Logger.LogLevel logLevel,
                @NotNull
                String message,
                @NotNull
                Object... args)

Logs the given message at logLevel. The message is formatted using String.format(String, Object...).

log

public void log(@NotNull
                Logger.LogLevel logLevel,
                @NotNull
                Throwable throwable)

Logs the given throwable at logLevel level.

log

public void log(@NotNull
                Logger.LogLevel logLevel,
                @NotNull
                Throwable throwable,
                @NotNull
                String message,
                @NotNull
                Object... args)

Logs the given throwable and message at logLevel. The message is formatted using String.format(String, Object...).

isInfoEnabled

public boolean isInfoEnabled()

Returns true if logging at Logger.LogLevel.INFO is enabled.

isDebugEnabled

public boolean isDebugEnabled()

Returns true if logging at Logger.LogLevel.DEBUG is enabled.

isTraceEnabled

public boolean isTraceEnabled()

Returns true if logging at Logger.LogLevel.TRACE is enabled.