Package com.pnfsoftware.jeb.util.logging

Interface ILogger

All Known Implementing Classes:
InternalLogger, StructuredLogger
public interface ILogger
Definition of a logger and logging levels.
See Also:

  • Method Details

    • getName

      String getName()
      Get the logger name.
      Returns:
      the logger name, or null for an anonymous logger

    • setEnabledLevel

      void setEnabledLevel(int level)
      Set the cut-off level for a logger.
      Parameters:
      level - the cut-off level: all logging calls with a level equal to or above the cut-off will be displayed

    • getEnabledLevel

      int getEnabledLevel()
      Retrieve the cut-off level for that logger.
      Returns:
      the level, a number between 0 and GlobalLog.LEVEL_CATCHING

    • log

      void log(int level, boolean raw, String format, Object... params)
      Log a string message.
      Parameters:
      level - log level
      raw - true to bypass standard prefixes and newline suffixes
      format - format string if parameters are provided, else plain message
      params - optional format parameters

    • i

      default void i(String format, Object... params)
      Reserved for internal logging. In Release builds, calling this method does nothing.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • trace

      default void trace(String format, Object... params)
      Log a trace message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • fine

      default void fine(String format, Object... params)
      Alias for trace(). Log a trace message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • debug

      default void debug(String format, Object... params)
      Log a debug message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • info

      default void info(String format, Object... params)
      Log an information message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • warn

      default void warn(String format, Object... params)
      Log a warning message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • warning

      default void warning(String format, Object... params)
      Alias for warn(). Log a warning message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • error

      default void error(String format, Object... params)
      Log an error message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • severe

      default void severe(String format, Object... params)
      Alias for error(). Log an error message.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters

    • catching

      default void catching(Throwable t)
      Log an exception's stack trace.
      Parameters:
      t - the throwable

    • catching

      default void catching(Throwable t, String message)
      Log an exception's stack trace, prefixed by an optional message.
      Parameters:
      t - the throwable
      message - optional message prefixing stack trace

    • catching

      default void catching(Throwable t, String format, Object... params)
      Log an exception's stack trace, prefixed by an optional message.
      Parameters:
      t - the throwable
      format - format string for the optional message
      params - format parameters

    • catchingSilent

      default void catchingSilent(Throwable t)
      Log an exception at the debug level.
      Parameters:
      t - the throwable

    • status

      default void status(String format, Object... params)
      Log a transient status message (STATUS). Status messages are not directed to the regular output destinations; instead, they are directed to the status sinks. Only the newest message is stored in the sink.
      Parameters:
      format - format string if parameters are provided, else standard string
      params - parameters