Package reactor.util

Interface Logger

public interface Logger
Logger interface designed for internal Reactor usage.

  • Method Details

    • getName

      String getName()
      Return the name of this Logger instance.
      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.

    • trace

      void trace(String msg)
      Log a message at the TRACE level.
      Parameters:
      msg - the message string to be logged

    • trace

      void trace(String format, @Nullable Object @Nullable ... 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.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • trace

      void trace(String msg, Throwable t)
      Log an exception (throwable) at the TRACE level with an accompanying message.
      Parameters:
      msg - the message accompanying the exception
      t - the exception (throwable) to log

    • 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(String msg)
      Log a message at the DEBUG level.
      Parameters:
      msg - the message string to be logged

    • debug

      void debug(String format, @Nullable Object @Nullable ... 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.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • debug

      void debug(String msg, 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(String msg)
      Log a message at the INFO level.
      Parameters:
      msg - the message string to be logged

    • info

      void info(String format, @Nullable Object @Nullable ... 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.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • info

      void info(String msg, 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

    • infoOrDebug

      default void infoOrDebug(Logger.ChoiceOfMessageSupplier messageSupplier)
      Convenience method to log a message that is different according to the log level. In priority, DEBUG level is used if isDebugEnabled(). Otherwise, INFO level is used (unless isInfoEnabled() is false).

      This can be used to log different level of details according to the active log level.

      Parameters:
      messageSupplier - the Logger.ChoiceOfMessageSupplier invoked in priority with true for the DEBUG level message, or false for INFO level
      See Also:

    • infoOrDebug

      default void infoOrDebug(Logger.ChoiceOfMessageSupplier messageSupplier, Throwable cause)
      Convenience method to log an exception (throwable), with an accompanying message that is different according to the log level. In priority, DEBUG level is used if isDebugEnabled(). Otherwise, INFO level is used (unless isInfoEnabled() is false).

      This can be used to log different level of details according to the active log level.

      Parameters:
      messageSupplier - the Logger.ChoiceOfMessageSupplier invoked in priority with true for the DEBUG level message, or false for INFO level
      cause - the Throwable the original exception to be logged
      See Also:

    • 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(String msg)
      Log a message at the WARN level.
      Parameters:
      msg - the message string to be logged

    • warn

      void warn(String format, @Nullable Object @Nullable ... 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.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • warn

      void warn(String msg, 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

    • warnOrDebug

      default void warnOrDebug(Logger.ChoiceOfMessageSupplier messageSupplier)
      Convenience method to log a message that is different according to the log level. In priority, DEBUG level is used if isDebugEnabled(). Otherwise, WARN level is used (unless isWarnEnabled() is false).

      This can be used to log different level of details according to the active log level.

      Parameters:
      messageSupplier - the Logger.ChoiceOfMessageSupplier invoked in priority with true for the DEBUG level message, or false for WARN level
      See Also:

    • warnOrDebug

      default void warnOrDebug(Logger.ChoiceOfMessageSupplier messageSupplier, Throwable cause)
      Convenience method to log an exception (throwable), with an accompanying message that is different according to the log level. In priority, DEBUG level is used if isDebugEnabled(). Otherwise, WARN level is used (unless isWarnEnabled() is false).

      This can be used to log different level of details according to the active log level.

      Parameters:
      messageSupplier - the Logger.ChoiceOfMessageSupplier invoked in priority with true for the DEBUG level message, or false for WARN level
      cause - the Throwable the original exception to be logged
      See Also:

    • 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(String msg)
      Log a message at the ERROR level.
      Parameters:
      msg - the message string to be logged

    • error

      void error(String format, @Nullable Object @Nullable ... 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.

      Parameters:
      format - the format string
      arguments - a list of 3 or more arguments

    • error

      void error(String msg, 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

    • errorOrDebug

      default void errorOrDebug(Logger.ChoiceOfMessageSupplier messageSupplier)
      Convenience method to log a message that is different according to the log level. In priority, DEBUG level is used if isDebugEnabled(). Otherwise, ERROR level is used (unless isErrorEnabled() is false).

      This can be used to log different level of details according to the active log level.

      Parameters:
      messageSupplier - the Logger.ChoiceOfMessageSupplier invoked in priority with true for the DEBUG level message, or false for ERROR level
      See Also:

    • errorOrDebug

      default void errorOrDebug(Logger.ChoiceOfMessageSupplier messageSupplier, Throwable cause)
      Convenience method to log an exception (throwable), with an accompanying message that is different according to the log level. In priority, DEBUG level is used if isDebugEnabled(). Otherwise, ERROR level is used (unless isErrorEnabled() is false).

      This can be used to log different level of details according to the active log level.

      Parameters:
      messageSupplier - the Logger.ChoiceOfMessageSupplier invoked in priority with true for the DEBUG level message, or false for ERROR level
      cause - the Throwable the original exception to be logged
      See Also: