Package org.apache.maven.api.plugin

Interface Log

All Known Implementing Classes:
DefaultLog
@Experimental @Provider public interface Log
This interface supplies the API for providing feedback to the user from the Mojo, using standard Maven channels. There should be no big surprises here, although you may notice that the methods accept java.lang.CharSequence rather than java.lang.String. This is provided mainly as a convenience, to enable developers to pass things like java.lang.StringBuffer directly into the logger, rather than formatting first by calling toString().
Since:
4.0.0

  • Method Details

    • isDebugEnabled

      boolean isDebugEnabled()
      Returns true if the debug error level is enabled.
      Returns:
      true if the debug error level is enabled

    • debug

      void debug(CharSequence content)
      Sends a message to the user in the debug error level.
      Parameters:
      content - the message to log

    • debug

      void debug(CharSequence content, Throwable error)
      Sends a message (and accompanying exception) to the user in the debug error level. The error's stacktrace will be output when this error level is enabled.
      Parameters:
      content - the message to log
      error - the error that caused this log

    • debug

      void debug(Throwable error)
      Sends an exception to the user in the debug error level. The stack trace for this exception will be output when this error level is enabled.
      Parameters:
      error - the error that caused this log

    • debug

      void debug(Supplier<String> content)

    • debug

      void debug(Supplier<String> content, Throwable error)

    • isInfoEnabled

      boolean isInfoEnabled()
      Returns true if the info error level is enabled.
      Returns:
      true if the info error level is enabled

    • info

      void info(CharSequence content)
      Sends a message to the user in the info error level.
      Parameters:
      content - the message to log

    • info

      void info(CharSequence content, Throwable error)
      Sends a message (and accompanying exception) to the user in the info error level. The error's stacktrace will be output when this error level is enabled.
      Parameters:
      content - the message to log
      error - the error that caused this log

    • info

      void info(Throwable error)
      Sends an exception to the user in the info error level. The stack trace for this exception will be output when this error level is enabled.
      Parameters:
      error - the error that caused this log

    • info

      void info(Supplier<String> content)

    • info

      void info(Supplier<String> content, Throwable error)

    • isWarnEnabled

      boolean isWarnEnabled()
      Returns true if the warn error level is enabled.
      Returns:
      true if the warn error level is enabled

    • warn

      void warn(CharSequence content)
      Sends a message to the user in the warn error level.
      Parameters:
      content - the message to log

    • warn

      void warn(CharSequence content, Throwable error)
      Sends a message (and accompanying exception) to the user in the warn error level. The error's stacktrace will be output when this error level is enabled.
      Parameters:
      content - the message to log
      error - the error that caused this log

    • warn

      void warn(Throwable error)
      Sends an exception to the user in the warn error level. The stack trace for this exception will be output when this error level is enabled.
      Parameters:
      error - the error that caused this log

    • warn

      void warn(Supplier<String> content)

    • warn

      void warn(Supplier<String> content, Throwable error)

    • isErrorEnabled

      boolean isErrorEnabled()
      Returns true if the error error level is enabled.
      Returns:
      true if the error error level is enabled

    • error

      void error(CharSequence content)
      Sends a message to the user in the error error level.
      Parameters:
      content - the message to log

    • error

      void error(CharSequence content, Throwable error)
      Sends a message (and accompanying exception) to the user in the error error level. The error's stacktrace will be output when this error level is enabled.
      Parameters:
      content - the message to log
      error - the error that caused this log

    • error

      void error(Throwable error)
      Sends an exception to the user in the error error level. The stack trace for this exception will be output when this error level is enabled.
      Parameters:
      error - the error that caused this log

    • error

      void error(Supplier<String> content)

    • error

      void error(Supplier<String> content, Throwable error)