org.slf4j.impl

Class BukkitLoggerAdapter

java.lang.Object

org.slf4j.impl.BukkitLoggerAdapter

All Implemented Interfaces:

org.slf4j.Logger

public final class BukkitLoggerAdapter
extends Object
implements org.slf4j.Logger

A merger of SLF4J's SimpleLogger and JDK14LoggerAdapter, wired to log all messages to the enclosing Bukkit plugin. The plugin is identified by reading the "name" attribute from plugin.yml in the current classloader.

Plugins that include SLF4Bukkit can use the following values in config.yml to configure the behavior of SLF4Bukkit. SLF4Bukkit uses Bukkit's plugin configuration API to retrieve config values, so both on-disk and built-in config.yml behavior is supported.

• slf4j.defaultLogLevel - Default log level for all SLF4Bukkit loggers in this plugin. Must be one of "trace", "debug", "info", "warn", or "error" (case-insensitive). If unspecified or given any other value, defaults to "info".
• slf4j.showHeader -Set to true if you want to output the [SLF4J] header. If unspecified or given any other value, defaults to false.
• slf4j.showLogName - Set to true if you want the logger instance name (wrapped in curly braces) to be included in output messages. If unspecified or given any other value, defaults to false. If this option is true, it overrides slf4j.showShortLogName.
• slf4j.showShortLogName - Set to true if you want the logger instance's short name (wrapped in curly braces) to be included in output messages. The short name is equal to the full name with every dot-separated portion of the full name (except the last portion) truncated to its first character. If unspecified or given any other value, defaults to true. This option is ignored if slf4j.showLogName is true.
• slf4j.showThreadName -Set to true if you want to output the current thread name, wrapped in brackets. If unspecified or given any other value, defaults to false.
• slf4j.colors.LEVEL - Default color for all messages of this level. Possible values come from SLF4Bukkit's ColorMarker values. Both keys and values in this section are treated as case-insensitive. Invalid values for either the key or value of an entry result in that entry being ignored. Default values are: error=RED, warn=YELLOW, others=NONE. When used programmatically via methods in this class, ColorMarkers always override these config values.
• slf4j.log.<em>a.b.c</em> - Logging detail level for an SLF4Bukkit logger instance in this plugin named "a.b.c". Right-side value must be one of "trace", "debug", "info", "warn", or "error" (case-insensitive). When a logger named "a.b.c" is initialized, its level is assigned from this property. If unspecified or given any other value, the level of the nearest parent logger will be used. If no parent logger level is set, then the value specified by slf4j.defaultLogLevel for this plugin will be used.

SLF4J messages at level TRACE or DEBUG are logged to Bukkit at level INFO because Bukkit does not enable any levels higher than INFO. Therefore, only SLF4J messages at level TRACE or DEBUG show their SLF4J level in the message that is logged to the server console.

Because SLF4Bukkit's configuration comes from the plugin configuration, SLF4Bukkit supports configuration reloading. To achieve this, call init(boolean) with argument true after calling Plugin.reloadConfig().

It is possible for SLF4J loggers to be used before the plugin is registered with Bukkit's plugin manager. SLF4Bukkit is considered to be uninitialized as long as the plugin cannot be retrieved from Bukkit's plugin manager. While in the uninitialized state, SLF4Bukkit:

• uses Bukkit.getLogger() instead of Plugin.getLogger().
• uses the default configuration values (see above).
• attempts to initialize itself upon every logging call until the plugin is retrievable from Bukkit's plugin manager, at which point SLF4Bukkit is considered to be initialized. Once initialized, Plugin.getLogger() and the plugin YAML configuration values are used.

For this reason, it is strongly recommended that you not emit any log messages via SLF4Bukkit until your plugin's onLoad() method has begun execution. (You can safely log messages inside the onLoad() method, because your plugin is registered by that time.) Logging inside static initializers, the plugin class constructor and other pre-plugin-registration areas of your code is discouraged.

With no configuration, the default output includes the logger short name and the message, followed by the line separator for the host.

This logger supports only ColorMarkers, which are used to format the logged message and throwable. All other marker types are ignored. The usage of markers does not affect whether or not a given logging level is enabled.

When executed on a Bukkit implementation that does not contain the JAnsi library (e.g. PaperSpigot), all color-related functionality is silently ignored. Any messages logged in such an environment by SLF4Bukkit will have any ChatColor values stripped. SLF4Bukkit does not emit any warnings when executed in an environment where JAnsi is not available.

Author:

Ceki Gülcü, Scott Sanders, Rod Waldhoff, Robert Burrell Donkin, Cédrik LIME, Peter Royal, Ronald Jack Jenkins Jr.

Field Summary

Fields inherited from interface org.slf4j.Logger

ROOT_LOGGER_NAME

Method Summary

Modifier and Type	Method and Description
void	debug(org.slf4j.Marker marker, String msg)
void	debug(org.slf4j.Marker marker, String format, Object... arguments)
void	debug(org.slf4j.Marker marker, String format, Object arg)
void	debug(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	debug(org.slf4j.Marker marker, String msg, Throwable t)
void	debug(String msg)
void	debug(String format, Object... arguments)
void	debug(String format, Object arg)
void	debug(String format, Object arg1, Object arg2)
void	debug(String msg, Throwable t)
void	error(org.slf4j.Marker marker, String msg)
void	error(org.slf4j.Marker marker, String format, Object... arguments)
void	error(org.slf4j.Marker marker, String format, Object arg)
void	error(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	error(org.slf4j.Marker marker, String msg, Throwable t)
void	error(String msg)
void	error(String format, Object... arguments)
void	error(String format, Object arg)
void	error(String format, Object arg1, Object arg2)
void	error(String msg, Throwable t)
String	getName()
void	info(org.slf4j.Marker marker, String msg)
void	info(org.slf4j.Marker marker, String format, Object... arguments)
void	info(org.slf4j.Marker marker, String format, Object arg)
void	info(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	info(org.slf4j.Marker marker, String msg, Throwable t)
void	info(String msg)
void	info(String format, Object... arguments)
void	info(String format, Object arg)
void	info(String format, Object arg1, Object arg2)
void	info(String msg, Throwable t)
static void	init(boolean reinitialize) (Re)initializes all SLF4Bukkit loggers in this plugin, relying on the YAML configuration of the plugin.
boolean	isDebugEnabled()
boolean	isDebugEnabled(org.slf4j.Marker marker)
boolean	isErrorEnabled()
boolean	isErrorEnabled(org.slf4j.Marker marker)
boolean	isInfoEnabled()
boolean	isInfoEnabled(org.slf4j.Marker marker)
boolean	isTraceEnabled()
boolean	isTraceEnabled(org.slf4j.Marker marker)
boolean	isWarnEnabled()
boolean	isWarnEnabled(org.slf4j.Marker marker)
void	trace(org.slf4j.Marker marker, String msg)
void	trace(org.slf4j.Marker marker, String format, Object... arguments)
void	trace(org.slf4j.Marker marker, String format, Object arg)
void	trace(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	trace(org.slf4j.Marker marker, String msg, Throwable t)
void	trace(String msg)
void	trace(String format, Object... arguments)
void	trace(String format, Object arg)
void	trace(String format, Object arg1, Object arg2)
void	trace(String msg, Throwable t)
void	warn(org.slf4j.Marker marker, String msg)
void	warn(org.slf4j.Marker marker, String format, Object... arguments)
void	warn(org.slf4j.Marker marker, String format, Object arg)
void	warn(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	warn(org.slf4j.Marker marker, String msg, Throwable t)
void	warn(String msg)
void	warn(String format, Object... arguments)
void	warn(String format, Object arg)
void	warn(String format, Object arg1, Object arg2)
void	warn(String msg, Throwable t)

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init(boolean reinitialize)

(Re)initializes all SLF4Bukkit loggers in this plugin, relying on the YAML configuration of the plugin.

Parameters:

reinitialize - set to true to reinitialize all loggers, e.g. after reloading the plugin config.

debug

public void debug(org.slf4j.Marker marker,
                  String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String format,
                  Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String format,
                  Object... arguments)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String format,
                  Object arg1,
                  Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String msg,
                  Throwable t)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String format,
                  Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String format,
                  Object... arguments)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String format,
                  Object arg1,
                  Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String msg,
                  Throwable t)

Specified by:

debug in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String format,
                  Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String format,
                  Object... arguments)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String format,
                  Object arg1,
                  Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String msg,
                  Throwable t)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String format,
                  Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String format,
                  Object... arguments)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String format,
                  Object arg1,
                  Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String msg,
                  Throwable t)

Specified by:

error in interface org.slf4j.Logger

getName

public String getName()

Specified by:

getName in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String format,
                 Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String format,
                 Object... arguments)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String format,
                 Object arg1,
                 Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String msg,
                 Throwable t)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String format,
                 Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String format,
                 Object... arguments)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String format,
                 Object arg1,
                 Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String msg,
                 Throwable t)

Specified by:

info in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled(org.slf4j.Marker marker)

Specified by:

isDebugEnabled in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled(org.slf4j.Marker marker)

Specified by:

isErrorEnabled in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled(org.slf4j.Marker marker)

Specified by:

isInfoEnabled in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled(org.slf4j.Marker marker)

Specified by:

isTraceEnabled in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled(org.slf4j.Marker marker)

Specified by:

isWarnEnabled in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String format,
                  Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String format,
                  Object... arguments)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String format,
                  Object arg1,
                  Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String msg,
                  Throwable t)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String format,
                  Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String format,
                  Object... arguments)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String format,
                  Object arg1,
                  Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String msg,
                  Throwable t)

Specified by:

trace in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String format,
                 Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String format,
                 Object... arguments)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String format,
                 Object arg1,
                 Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String msg,
                 Throwable t)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String format,
                 Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String format,
                 Object... arguments)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String format,
                 Object arg1,
                 Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String msg,
                 Throwable t)

Specified by:

warn in interface org.slf4j.Logger