Interface Logger
-
- All Known Subinterfaces:
LocationAwareLogger
- All Known Implementing Classes:
EventRecodingLogger,Logger,MarkerIgnoringBase,NOPLogger,SubstituteLogger
public interface LoggerThe org.slf4j.Logger interface is the main user entry point of SLF4J API. It is expected that logging takes place through concrete implementations of this interface.Typical usage pattern:
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class Wombat { final static Logger logger = LoggerFactory.getLogger(Wombat.class); Integer t; Integer oldT; public void setTemperature(Integer temperature) { oldT = t; t = temperature; logger.debug("Temperature set to {}. Old temperature was {}.", t, oldT); if(temperature.intValue() > 50) { logger.info("Temperature has risen above 50 degrees."); } } }Be sure to read the FAQ entry relating to parameterized logging. Note that logging statements can be parameterized in presence of an exception/throwable.Once you are comfortable using loggers, i.e. instances of this interface, consider using MDC as well as Markers.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringROOT_LOGGER_NAMECase insensitive String constant used to retrieve the name of the root logger.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddebug(java.lang.String msg)Log a message at the DEBUG level.voiddebug(java.lang.String format, java.lang.Object arg)Log a message at the DEBUG level according to the specified format and argument.voiddebug(java.lang.String format, java.lang.Object... arguments)Log a message at the DEBUG level according to the specified format and arguments.voiddebug(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.voiddebug(java.lang.String msg, java.lang.Throwable t)Log an exception (throwable) at the DEBUG level with an accompanying message.voiddebug(Marker marker, java.lang.String msg)Log a message with the specific Marker at the DEBUG level.voiddebug(Marker marker, java.lang.String format, java.lang.Object arg)This method is similar todebug(String, Object)method except that the marker data is also taken into consideration.voiddebug(Marker marker, java.lang.String format, java.lang.Object... arguments)This method is similar todebug(String, Object...)method except that the marker data is also taken into consideration.voiddebug(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)This method is similar todebug(String, Object, Object)method except that the marker data is also taken into consideration.voiddebug(Marker marker, java.lang.String msg, java.lang.Throwable t)This method is similar todebug(String, Throwable)method except that the marker data is also taken into consideration.voiderror(java.lang.String msg)Log a message at the ERROR level.voiderror(java.lang.String format, java.lang.Object arg)Log a message at the ERROR level according to the specified format and argument.voiderror(java.lang.String format, java.lang.Object... arguments)Log a message at the ERROR level according to the specified format and arguments.voiderror(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.voiderror(java.lang.String msg, java.lang.Throwable t)Log an exception (throwable) at the ERROR level with an accompanying message.voiderror(Marker marker, java.lang.String msg)Log a message with the specific Marker at the ERROR level.voiderror(Marker marker, java.lang.String format, java.lang.Object arg)This method is similar toerror(String, Object)method except that the marker data is also taken into consideration.voiderror(Marker marker, java.lang.String format, java.lang.Object... arguments)This method is similar toerror(String, Object...)method except that the marker data is also taken into consideration.voiderror(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)This method is similar toerror(String, Object, Object)method except that the marker data is also taken into consideration.voiderror(Marker marker, java.lang.String msg, java.lang.Throwable t)This method is similar toerror(String, Throwable)method except that the marker data is also taken into consideration.java.lang.StringgetName()Return the name of thisLoggerinstance.voidinfo(java.lang.String msg)Log a message at the INFO level.voidinfo(java.lang.String format, java.lang.Object arg)Log a message at the INFO level according to the specified format and argument.voidinfo(java.lang.String format, java.lang.Object... arguments)Log a message at the INFO level according to the specified format and arguments.voidinfo(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.voidinfo(java.lang.String msg, java.lang.Throwable t)Log an exception (throwable) at the INFO level with an accompanying message.voidinfo(Marker marker, java.lang.String msg)Log a message with the specific Marker at the INFO level.voidinfo(Marker marker, java.lang.String format, java.lang.Object arg)This method is similar toinfo(String, Object)method except that the marker data is also taken into consideration.voidinfo(Marker marker, java.lang.String format, java.lang.Object... arguments)This method is similar toinfo(String, Object...)method except that the marker data is also taken into consideration.voidinfo(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)This method is similar toinfo(String, Object, Object)method except that the marker data is also taken into consideration.voidinfo(Marker marker, java.lang.String msg, java.lang.Throwable t)This method is similar toinfo(String, Throwable)method except that the marker data is also taken into consideration.booleanisDebugEnabled()Is the logger instance enabled for the DEBUG level?booleanisDebugEnabled(Marker marker)Similar toisDebugEnabled()method except that the marker data is also taken into account.booleanisErrorEnabled()Is the logger instance enabled for the ERROR level?booleanisErrorEnabled(Marker marker)Similar toisErrorEnabled()method except that the marker data is also taken into consideration.booleanisInfoEnabled()Is the logger instance enabled for the INFO level?booleanisInfoEnabled(Marker marker)Similar toisInfoEnabled()method except that the marker data is also taken into consideration.booleanisTraceEnabled()Is the logger instance enabled for the TRACE level?booleanisTraceEnabled(Marker marker)Similar toisTraceEnabled()method except that the marker data is also taken into account.booleanisWarnEnabled()Is the logger instance enabled for the WARN level?booleanisWarnEnabled(Marker marker)Similar toisWarnEnabled()method except that the marker data is also taken into consideration.voidtrace(java.lang.String msg)Log a message at the TRACE level.voidtrace(java.lang.String format, java.lang.Object arg)Log a message at the TRACE level according to the specified format and argument.voidtrace(java.lang.String format, java.lang.Object... arguments)Log a message at the TRACE level according to the specified format and arguments.voidtrace(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)Log a message at the TRACE level according to the specified format and arguments.voidtrace(java.lang.String msg, java.lang.Throwable t)Log an exception (throwable) at the TRACE level with an accompanying message.voidtrace(Marker marker, java.lang.String msg)Log a message with the specific Marker at the TRACE level.voidtrace(Marker marker, java.lang.String format, java.lang.Object arg)This method is similar totrace(String, Object)method except that the marker data is also taken into consideration.voidtrace(Marker marker, java.lang.String format, java.lang.Object... argArray)This method is similar totrace(String, Object...)method except that the marker data is also taken into consideration.voidtrace(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)This method is similar totrace(String, Object, Object)method except that the marker data is also taken into consideration.voidtrace(Marker marker, java.lang.String msg, java.lang.Throwable t)This method is similar totrace(String, Throwable)method except that the marker data is also taken into consideration.voidwarn(java.lang.String msg)Log a message at the WARN level.voidwarn(java.lang.String format, java.lang.Object arg)Log a message at the WARN level according to the specified format and argument.voidwarn(java.lang.String format, java.lang.Object... arguments)Log a message at the WARN level according to the specified format and arguments.voidwarn(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.voidwarn(java.lang.String msg, java.lang.Throwable t)Log an exception (throwable) at the WARN level with an accompanying message.voidwarn(Marker marker, java.lang.String msg)Log a message with the specific Marker at the WARN level.voidwarn(Marker marker, java.lang.String format, java.lang.Object arg)This method is similar towarn(String, Object)method except that the marker data is also taken into consideration.voidwarn(Marker marker, java.lang.String format, java.lang.Object... arguments)This method is similar towarn(String, Object...)method except that the marker data is also taken into consideration.voidwarn(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)This method is similar towarn(String, Object, Object)method except that the marker data is also taken into consideration.voidwarn(Marker marker, java.lang.String msg, java.lang.Throwable t)This method is similar towarn(String, Throwable)method except that the marker data is also taken into consideration.
-
-
-
Field Detail
-
ROOT_LOGGER_NAME
static final java.lang.String ROOT_LOGGER_NAME
Case insensitive String constant used to retrieve the name of the root logger.- Since:
- 1.3
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
Return the name of thisLoggerinstance.- Returns:
- name of this logger instance
-
isTraceEnabled
boolean isTraceEnabled()
Is the logger instance enabled for the TRACE level?- Returns:
- True if this Logger is enabled for the TRACE level, false otherwise.
- Since:
- 1.4
-
trace
void trace(java.lang.String msg)
Log a message at the TRACE level.- Parameters:
msg- the message string to be logged- Since:
- 1.4
-
trace
void trace(java.lang.String format, java.lang.Object arg)Log a message at the TRACE level according to the specified format and argument.This form avoids superfluous object creation when the logger is disabled for the TRACE level.
- Parameters:
format- the format stringarg- the argument- Since:
- 1.4
-
trace
void trace(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)Log a message at the TRACE level according to the specified format and arguments.This form avoids superfluous object creation when the logger is disabled for the TRACE level.
- Parameters:
format- the format stringarg1- the first argumentarg2- the second argument- Since:
- 1.4
-
trace
void trace(java.lang.String format, java.lang.Object... arguments)Log a message at the TRACE level according to the specified format and arguments.This form avoids superfluous string concatenation when the logger is disabled for the TRACE 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 TRACE. The variants takingoneandtwoarguments exist solely in order to avoid this hidden cost.- Parameters:
format- the format stringarguments- a list of 3 or more arguments- Since:
- 1.4
-
trace
void trace(java.lang.String msg, java.lang.Throwable t)Log an exception (throwable) at the TRACE level with an accompanying message.- Parameters:
msg- the message accompanying the exceptiont- the exception (throwable) to log- Since:
- 1.4
-
isTraceEnabled
boolean isTraceEnabled(Marker marker)
Similar toisTraceEnabled()method except that the marker data is also taken into account.- Parameters:
marker- The marker data to take into consideration- Returns:
- True if this Logger is enabled for the TRACE level, false otherwise.
- Since:
- 1.4
-
trace
void trace(Marker marker, java.lang.String msg)
Log a message with the specific Marker at the TRACE level.- Parameters:
marker- the marker data specific to this log statementmsg- the message string to be logged- Since:
- 1.4
-
trace
void trace(Marker marker, java.lang.String format, java.lang.Object arg)
This method is similar totrace(String, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg- the argument- Since:
- 1.4
-
trace
void trace(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
This method is similar totrace(String, Object, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg1- the first argumentarg2- the second argument- Since:
- 1.4
-
trace
void trace(Marker marker, java.lang.String format, java.lang.Object... argArray)
This method is similar totrace(String, Object...)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringargArray- an array of arguments- Since:
- 1.4
-
trace
void trace(Marker marker, java.lang.String msg, java.lang.Throwable t)
This method is similar totrace(String, Throwable)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementmsg- the message accompanying the exceptiont- the exception (throwable) to log- Since:
- 1.4
-
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 stringarg- 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 stringarg1- the first argumentarg2- 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 takingoneandtwoarguments exist solely in order to avoid this hidden cost.- Parameters:
format- the format stringarguments- 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 exceptiont- the exception (throwable) to log
-
isDebugEnabled
boolean isDebugEnabled(Marker marker)
Similar toisDebugEnabled()method except that the marker data is also taken into account.- Parameters:
marker- The marker data to take into consideration- Returns:
- True if this Logger is enabled for the DEBUG level, false otherwise.
-
debug
void debug(Marker marker, java.lang.String msg)
Log a message with the specific Marker at the DEBUG level.- Parameters:
marker- the marker data specific to this log statementmsg- the message string to be logged
-
debug
void debug(Marker marker, java.lang.String format, java.lang.Object arg)
This method is similar todebug(String, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg- the argument
-
debug
void debug(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
This method is similar todebug(String, Object, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg1- the first argumentarg2- the second argument
-
debug
void debug(Marker marker, java.lang.String format, java.lang.Object... arguments)
This method is similar todebug(String, Object...)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarguments- a list of 3 or more arguments
-
debug
void debug(Marker marker, java.lang.String msg, java.lang.Throwable t)
This method is similar todebug(String, Throwable)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementmsg- the message accompanying the exceptiont- 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 stringarg- 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 stringarg1- the first argumentarg2- 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 takingoneandtwoarguments exist solely in order to avoid this hidden cost.- Parameters:
format- the format stringarguments- 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 exceptiont- the exception (throwable) to log
-
isInfoEnabled
boolean isInfoEnabled(Marker marker)
Similar toisInfoEnabled()method except that the marker data is also taken into consideration.- Parameters:
marker- The marker data to take into consideration- Returns:
- true if this logger is warn enabled, false otherwise
-
info
void info(Marker marker, java.lang.String msg)
Log a message with the specific Marker at the INFO level.- Parameters:
marker- The marker specific to this log statementmsg- the message string to be logged
-
info
void info(Marker marker, java.lang.String format, java.lang.Object arg)
This method is similar toinfo(String, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg- the argument
-
info
void info(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
This method is similar toinfo(String, Object, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg1- the first argumentarg2- the second argument
-
info
void info(Marker marker, java.lang.String format, java.lang.Object... arguments)
This method is similar toinfo(String, Object...)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarguments- a list of 3 or more arguments
-
info
void info(Marker marker, java.lang.String msg, java.lang.Throwable t)
This method is similar toinfo(String, Throwable)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data for this log statementmsg- the message accompanying the exceptiont- 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 stringarg- the 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 takingoneandtwoarguments exist solely in order to avoid this hidden cost.- Parameters:
format- the format stringarguments- a list of 3 or more arguments
-
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 stringarg1- the first argumentarg2- the second argument
-
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 exceptiont- the exception (throwable) to log
-
isWarnEnabled
boolean isWarnEnabled(Marker marker)
Similar toisWarnEnabled()method except that the marker data is also taken into consideration.- Parameters:
marker- The marker data to take into consideration- Returns:
- True if this Logger is enabled for the WARN level, false otherwise.
-
warn
void warn(Marker marker, java.lang.String msg)
Log a message with the specific Marker at the WARN level.- Parameters:
marker- The marker specific to this log statementmsg- the message string to be logged
-
warn
void warn(Marker marker, java.lang.String format, java.lang.Object arg)
This method is similar towarn(String, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg- the argument
-
warn
void warn(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
This method is similar towarn(String, Object, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg1- the first argumentarg2- the second argument
-
warn
void warn(Marker marker, java.lang.String format, java.lang.Object... arguments)
This method is similar towarn(String, Object...)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarguments- a list of 3 or more arguments
-
warn
void warn(Marker marker, java.lang.String msg, java.lang.Throwable t)
This method is similar towarn(String, Throwable)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data for this log statementmsg- the message accompanying the exceptiont- 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 stringarg- 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 stringarg1- the first argumentarg2- 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 takingoneandtwoarguments exist solely in order to avoid this hidden cost.- Parameters:
format- the format stringarguments- 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 exceptiont- the exception (throwable) to log
-
isErrorEnabled
boolean isErrorEnabled(Marker marker)
Similar toisErrorEnabled()method except that the marker data is also taken into consideration.- Parameters:
marker- The marker data to take into consideration- Returns:
- True if this Logger is enabled for the ERROR level, false otherwise.
-
error
void error(Marker marker, java.lang.String msg)
Log a message with the specific Marker at the ERROR level.- Parameters:
marker- The marker specific to this log statementmsg- the message string to be logged
-
error
void error(Marker marker, java.lang.String format, java.lang.Object arg)
This method is similar toerror(String, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg- the argument
-
error
void error(Marker marker, java.lang.String format, java.lang.Object arg1, java.lang.Object arg2)
This method is similar toerror(String, Object, Object)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarg1- the first argumentarg2- the second argument
-
error
void error(Marker marker, java.lang.String format, java.lang.Object... arguments)
This method is similar toerror(String, Object...)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementformat- the format stringarguments- a list of 3 or more arguments
-
error
void error(Marker marker, java.lang.String msg, java.lang.Throwable t)
This method is similar toerror(String, Throwable)method except that the marker data is also taken into consideration.- Parameters:
marker- the marker data specific to this log statementmsg- the message accompanying the exceptiont- the exception (throwable) to log
-
-