Class DefaultLog

java.lang.Object
org.apache.rat.utils.DefaultLog
All Implemented Interfaces:
Log
public final class DefaultLog extends Object implements Log
A default implementation of Log that writes to System.out and System.err.

The singleton instance is stored in a ThreadLocal so that each thread (e.g. parallel Maven reactor threads) gets its own logger and does not interfere with loggers set by other threads.

  • Method Details

    • getInstance

      public static Log getInstance()
      Retrieves the DefaultLog instance for the current thread.
      Returns:
      the Default log instance.

    • setInstance

      public static Log setInstance(Log newInstance)
      Sets the default log instance for the current thread. If not set an instance of DefaultLog will be returned.
      Parameters:
      newInstance - a Log to use as the default.
      Returns:
      the old instance.

    • createDefault

      public static Log createDefault()
      Creates a new instance of the default log.
      Returns:
      A new instance of the default log.

    • setLevel

      public void setLevel(Log.Level level)
      Sets the level. Log messages below the specified level will not be written to the log.
      Specified by:
      setLevel in interface Log
      Parameters:
      level - the level to use when writing messages.

    • getLevel

      public Log.Level getLevel()
      Gets the level we are writing at.
      Specified by:
      getLevel in interface Log
      Returns:
      the level we are writing at.

    • log

      public void log(Log.Level level, String msg)
      Description copied from interface: Log
      Writes a message at a specific log level.
      Specified by:
      log in interface Log
      Parameters:
      level - The log level to write at.
      msg - the message to write.