Package org.apache.rat.utils

Interface Log

All Known Implementing Classes:
DefaultLog
public interface Log
The definition of logging for the core. UIs are expected to provide an implementation of Log to log data to the appropriate system within the UI.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    Log.Level
    The log levels supported by logging.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Writer
    asWriter()
    Returns a Writer backed by this log.
    default Writer
    asWriter(Log.Level level)
    Returns a Writer backed by this log.
    default void
    debug(Object message)
    Write a message at DEBUG level.
    default void
    debug(Object message, Throwable throwable)
    Write a debug message and report throwable stack trace.
    default void
    error(Object message)
    Write a message at ERROR level.
    default void
    error(Object message, Throwable throwable)
    Write an error message and report throwable stack trace.
    Log.Level
    getLevel()
    Gets the log level that is enabled.
    default void
    info(Object message)
    Write a message at INFO level.
    default void
    info(Object message, Throwable throwable)
    Write an info message and report throwable stack trace.
    default boolean
    isEnabled(Log.Level level)
    Determines if the log level is enabled.
    default void
    log(Log.Level level, Object message)
    Writes a log message at the specified level.
    default void
    log(Log.Level level, Object message, Throwable throwable)
    Write a log message and report throwable stack trace at the specified log level.
    void
    log(Log.Level level, String message)
    Writes a message at a specific log level.
    default void
    log(Log.Level level, String message, Throwable throwable)
    Write a log message and report throwable stack trace at the specified log level.
    default void
    setLevel(Log.Level level)
    Sets the log level.
    default void
    warn(Object message)
    Write a message at WARN level.
    default void
    warn(Object message, Throwable throwable)
    Write a warn message and report throwable stack trace.

  • Method Details

    • getLevel

      Log.Level getLevel()
      Gets the log level that is enabled. If encapsulated logger does not report level implementations should return DEBUG.
      Returns:
      the level that is enabled.

    • setLevel

      default void setLevel(Log.Level level)
      Sets the log level. Implementations may elect not to set the level dynamically. However, if the option is supported this method should be overridden.
      Parameters:
      level - the level to set.

    • isEnabled

      default boolean isEnabled(Log.Level level)
      Determines if the log level is enabled.
      Parameters:
      level - The level to check.
      Returns:
      true if the level will produce output in the log.

    • log

      void log(Log.Level level, String message)
      Writes a message at a specific log level.
      Parameters:
      level - The log level to write at.
      message - the message to write.

    • log

      default void log(Log.Level level, Object message)
      Writes a log message at the specified level.
      Parameters:
      level - the level to write the message at.
      message - the message to write.

    • debug

      default void debug(Object message)
      Write a message at DEBUG level.
      Parameters:
      message - the message to write.

    • info

      default void info(Object message)
      Write a message at INFO level.
      Parameters:
      message - the message to write.

    • warn

      default void warn(Object message)
      Write a message at WARN level.
      Parameters:
      message - the message to write.

    • error

      default void error(Object message)
      Write a message at ERROR level.
      Parameters:
      message - the message to write.

    • log

      default void log(Log.Level level, String message, Throwable throwable)
      Write a log message and report throwable stack trace at the specified log level.
      Parameters:
      level - the level to report at
      message - the message for the log
      throwable - the throwable

    • log

      default void log(Log.Level level, Object message, Throwable throwable)
      Write a log message and report throwable stack trace at the specified log level.
      Parameters:
      level - the level to report at
      message - the message for the log
      throwable - the throwable

    • debug

      default void debug(Object message, Throwable throwable)
      Write a debug message and report throwable stack trace.
      Parameters:
      message - the message for the log
      throwable - the throwable

    • info

      default void info(Object message, Throwable throwable)
      Write an info message and report throwable stack trace.
      Parameters:
      message - the message for the log
      throwable - the throwable

    • warn

      default void warn(Object message, Throwable throwable)
      Write a warn message and report throwable stack trace.
      Parameters:
      message - the message for the log
      throwable - the throwable

    • error

      default void error(Object message, Throwable throwable)
      Write an error message and report throwable stack trace.
      Parameters:
      message - the message for the log
      throwable - the throwable

    • asWriter

      default Writer asWriter()
      Returns a Writer backed by this log. All messages are logged at "INFO" level.
      Returns:
      the Writer backed by this log.

    • asWriter

      default Writer asWriter(Log.Level level)
      Returns a Writer backed by this log. All messages are logged at "INFO" level.
      Parameters:
      level - the Log level to write at.
      Returns:
      the Writer backed by this log.