Interface Logger

public interface Logger
A logger through which to provide feedback to the user about a run.

The difference between the event handler and the logger is that the event handler is for events intended to be consumed by the client software whereas the logger is for messages intended to be consumed by the client *user* (i.e., a human).

Implementations of this interface must be thread-safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    ansiCodesSupported()
    True if ANSI color codes are understood by this instance.
    void
    debug(String msg)
    Provide a debug message.
    void
    error(String msg)
    Provide an error message.
    void
    info(String msg)
    Provide an info message.
    void
    trace(Throwable t)
    Provide a stack trace
    void
    warn(String msg)
    Provide an warning message.

  • Method Details

    • ansiCodesSupported

      boolean ansiCodesSupported()
      True if ANSI color codes are understood by this instance.

    • error

      void error(String msg)
      Provide an error message.
      Parameters:
      msg - the error message

    • warn

      void warn(String msg)
      Provide an warning message.
      Parameters:
      msg - the warning message

    • info

      void info(String msg)
      Provide an info message.
      Parameters:
      msg - the info message

    • debug

      void debug(String msg)
      Provide a debug message.
      Parameters:
      msg - the debug message

    • trace

      void trace(Throwable t)
      Provide a stack trace
      Parameters:
      t - the Throwable containing the stack trace being logged