Package org.apache.maven.shared.utils.logging

Interface MessageBuilder

public interface MessageBuilder
Message builder that supports configurable styling. An instance of this interface can be retrieved with MessageUtils.buffer(). After the message has been constructed with any of the append methods its content can be retrieved with build().
Since:
3.1.0
See Also:

  • Method Details

    • success

      MessageBuilder success(Object message)
      Append message content in success style. By default, bold green
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • warning

      MessageBuilder warning(Object message)
      Append message content in warning style. By default, bold yellow
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • failure

      MessageBuilder failure(Object message)
      Append message content in failure style. By default, bold red
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • strong

      MessageBuilder strong(Object message)
      Append message content in strong style. By default, bold
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • mojo

      MessageBuilder mojo(Object message)
      Append message content in mojo style. By default, green
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • project

      MessageBuilder project(Object message)
      Append message content in project style. By default, cyan
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • a

      MessageBuilder a(char[] value, int offset, int len)
      Append content to the message buffer.
      Parameters:
      value - the content to append
      offset - the index of the first char to append
      len - the number of chars to append
      Returns:
      the current builder

    • a

      MessageBuilder a(char[] value)
      Append content to the message buffer.
      Parameters:
      value - the content to append
      Returns:
      the current builder

    • a

      MessageBuilder a(CharSequence value, int start, int end)
      Append content to the message buffer.
      Parameters:
      value - the content to append
      start - the starting index of the subsequence to be appended
      end - the end index of the subsequence to be appended
      Returns:
      the current builder

    • a

      MessageBuilder a(CharSequence value)
      Append content to the message buffer.
      Parameters:
      value - the content to append
      Returns:
      the current builder

    • a

      MessageBuilder a(Object value)
      Append content to the message buffer.
      Parameters:
      value - the content to append
      Returns:
      the current builder

    • newline

      MessageBuilder newline()
      Append newline to the message buffer.
      Returns:
      the current builder

    • format

      MessageBuilder format(String pattern, Object... args)
      Append formatted content to the buffer.
      Parameters:
      pattern - a format string according to the Formatter syntax
      args - arguments referenced by the format specifiers in the format string.
      Returns:
      the current builder
      See Also:

    • build

      String build()
      Get the message constructed by this builder. The underlying buffer is not reset with this method, i.e. if you continue using this builder you just append content to the existing one.
      Returns:
      the message
      Since:
      4.0.0

    • toString

      @Deprecated String toString()
      Deprecated.
      Rather use build()
      Same as build().
      Overrides:
      toString in class Object