Module xyz.ronella.logging.logger.plus
Package xyz.ronella.logging

Class LoggerPlus

java.lang.Object
xyz.ronella.logging.LoggerPlus
public class LoggerPlus extends Object
Add functionality to logging.
Since:
2019-11-27

  • Constructor Details

    • LoggerPlus

      public LoggerPlus(org.slf4j.Logger logger)
      Creates an instance of LoggerPlus.
      Parameters:
      logger - Accepts an instance of Logger.

  • Method Details

    • getLogger

      public org.slf4j.Logger getLogger()
      Return the instance of the logger used.
      Returns:
      An instance of Logger.

    • debug

      public void debug(String message)
      Accepts a debug message.
      Parameters:
      message - The message.

    • debug

      public void debug(String format, Object... values)
      Accepts a String.format(ted) debug message.
      Parameters:
      format - The format for the message.
      values - The values of the String.format(ted) message
      Since:
      1.2.0

    • debug

      public void debug(Supplier<String> message)
      Accepts a supplier of a message.
      Parameters:
      message - The supplier of message.

    • info

      public void info(String message)
      Accepts an info message.
      Parameters:
      message - The info message.

    • info

      public void info(String format, Object... values)
      Accepts a String.format(ted) info message.
      Parameters:
      format - The format for the message.
      values - The values of the String.format(ted) message
      Since:
      1.2.0

    • info

      public void info(Supplier<String> message)
      Accepts a supplier of a message.
      Parameters:
      message - The supplier of message.

    • error

      public void error(String message)
      Accepts an error message.
      Parameters:
      message - The error message.

    • error

      public void error(Supplier<String> message)
      Accepts a supplier of a message.
      Parameters:
      message - The supplier of message.

    • error

      public void error(String format, Object... values)
      Accepts a String.format(ted) error message.
      Parameters:
      format - The format for the message.
      values - The values of the String.format(ted) message
      Since:
      1.2.0

    • warn

      public void warn(String message)
      Accepts a warning message.
      Parameters:
      message - The warning message.

    • warn

      public void warn(String format, Object... values)
      Accepts a String.format(ted) warn message.
      Parameters:
      format - The format for the message.
      values - The values of the String.format(ted) message
      Since:
      1.2.0

    • warn

      public void warn(Supplier<String> message)
      Accepts a supplier of a message.
      Parameters:
      message - The supplier of message.

    • trace

      public void trace(String message)
      Accept a trace message.
      Parameters:
      message - The trace message.

    • trace

      public void trace(String format, Object... values)
      Accepts a String.format(ted) trace message.
      Parameters:
      format - The format for the message.
      values - The values of the String.format(ted) message
      Since:
      1.2.0

    • trace

      public void trace(Supplier<String> message)
      Accepts a supplier of a message.
      Parameters:
      message - The supplier of message.

    • logByMethodCall

      @Deprecated public LoggerPlus.MethodLogger logByMethodCall(String methodName, boolean withHeader)
      Deprecated.
      Use groupLog instead.
      Return an instance of MethodLogger that can be used log messages associated with the method.
      Parameters:
      methodName - The method name.
      withHeader - Place a log header message in each method class.
      Returns:
      An instance of MethodLogger.

    • logByMethodCall

      @Deprecated public LoggerPlus.MethodLogger logByMethodCall(String methodName)
      Deprecated.
      Use groupLog instead.
      Return an instance of MethodLogger that can be used log messages associated with the method.
      Parameters:
      methodName - The method name.
      Returns:
      An instance of MethodLogger.

    • groupLog

      public LoggerPlus.GroupLogger groupLog(String groupName, boolean withHeader)
      Return an instance of GroupLogger that can be used log messages by group.
      Parameters:
      groupName - The group name.
      withHeader - Place a log header message with each group.
      Returns:
      An instance of GroupLogger.
      Since:
      1.1.0

    • groupLog

      public LoggerPlus.GroupLogger groupLog(String groupName)
      Return an instance of GroupLogger that can be used log messages by group.
      Parameters:
      groupName - The group name.
      Returns:
      An instance of GroupLogger.
      Since:
      1.1.0

    • getStackTraceAsString

      public String getStackTraceAsString(Exception exception)
      Capture the stacktrace as string from an exception.
      Parameters:
      exception - An instance of exception.
      Returns:
      The string equivalent of stacktrace.