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

Class AnsiMessageBuilder

java.lang.Object
org.apache.maven.shared.utils.logging.AnsiMessageBuilder
All Implemented Interfaces:
LoggerLevelRenderer, MessageBuilder
class AnsiMessageBuilder extends Object implements MessageBuilder, LoggerLevelRenderer
Message builder implementation that supports ANSI colors through Jansi with configurable styles through Style.

  • Field Details

    • ansi

      private org.fusesource.jansi.Ansi ansi

  • Constructor Details

    • AnsiMessageBuilder

      AnsiMessageBuilder()

    • AnsiMessageBuilder

      AnsiMessageBuilder(StringBuilder builder)

    • AnsiMessageBuilder

      AnsiMessageBuilder(int size)

    • AnsiMessageBuilder

      AnsiMessageBuilder(org.fusesource.jansi.Ansi ansi)

  • Method Details

    • debug

      public String debug(String message)
      Description copied from interface: LoggerLevelRenderer
      Render a message at DEBUG level.
      Specified by:
      debug in interface LoggerLevelRenderer
      Parameters:
      message - the message to render.
      Returns:
      the formatted message.

    • info

      public String info(String message)
      Description copied from interface: LoggerLevelRenderer
      Render a message at INFO level.
      Specified by:
      info in interface LoggerLevelRenderer
      Parameters:
      message - the message to render.
      Returns:
      the formatted message.

    • warning

      public String warning(String message)
      Description copied from interface: LoggerLevelRenderer
      Render a message at WARNING level.
      Specified by:
      warning in interface LoggerLevelRenderer
      Parameters:
      message - the message to render.
      Returns:
      the formatted message.

    • error

      public String error(String message)
      Description copied from interface: LoggerLevelRenderer
      Render a message at ERROR level.
      Specified by:
      error in interface LoggerLevelRenderer
      Parameters:
      message - the message to render.
      Returns:
      the formatted message.

    • success

      public AnsiMessageBuilder success(Object message)
      Description copied from interface: MessageBuilder
      Append message content in success style. By default, bold green
      Specified by:
      success in interface MessageBuilder
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • warning

      public AnsiMessageBuilder warning(Object message)
      Description copied from interface: MessageBuilder
      Append message content in warning style. By default, bold yellow
      Specified by:
      warning in interface MessageBuilder
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • failure

      public AnsiMessageBuilder failure(Object message)
      Description copied from interface: MessageBuilder
      Append message content in failure style. By default, bold red
      Specified by:
      failure in interface MessageBuilder
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • strong

      public AnsiMessageBuilder strong(Object message)
      Description copied from interface: MessageBuilder
      Append message content in strong style. By default, bold
      Specified by:
      strong in interface MessageBuilder
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • mojo

      public AnsiMessageBuilder mojo(Object message)
      Description copied from interface: MessageBuilder
      Append message content in mojo style. By default, green
      Specified by:
      mojo in interface MessageBuilder
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • project

      public AnsiMessageBuilder project(Object message)
      Description copied from interface: MessageBuilder
      Append message content in project style. By default, cyan
      Specified by:
      project in interface MessageBuilder
      Parameters:
      message - the message to append
      Returns:
      the current builder

    • a

      public AnsiMessageBuilder a(char[] value, int offset, int len)
      Description copied from interface: MessageBuilder
      Append content to the message buffer.
      Specified by:
      a in interface MessageBuilder
      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

      public AnsiMessageBuilder a(char[] value)
      Description copied from interface: MessageBuilder
      Append content to the message buffer.
      Specified by:
      a in interface MessageBuilder
      Parameters:
      value - the content to append
      Returns:
      the current builder

    • a

      public AnsiMessageBuilder a(CharSequence value, int start, int end)
      Description copied from interface: MessageBuilder
      Append content to the message buffer.
      Specified by:
      a in interface MessageBuilder
      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

      public AnsiMessageBuilder a(CharSequence value)
      Description copied from interface: MessageBuilder
      Append content to the message buffer.
      Specified by:
      a in interface MessageBuilder
      Parameters:
      value - the content to append
      Returns:
      the current builder

    • a

      public AnsiMessageBuilder a(Object value)
      Description copied from interface: MessageBuilder
      Append content to the message buffer.
      Specified by:
      a in interface MessageBuilder
      Parameters:
      value - the content to append
      Returns:
      the current builder

    • newline

      public AnsiMessageBuilder newline()
      Description copied from interface: MessageBuilder
      Append newline to the message buffer.
      Specified by:
      newline in interface MessageBuilder
      Returns:
      the current builder

    • format

      public AnsiMessageBuilder format(String pattern, Object... args)
      Description copied from interface: MessageBuilder
      Append formatted content to the buffer.
      Specified by:
      format in interface MessageBuilder
      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:

    • toString

      public String toString()
      Description copied from interface: MessageBuilder
      Same as MessageBuilder.build().
      Specified by:
      toString in interface MessageBuilder
      Overrides:
      toString in class Object

    • build

      public String build()
      Description copied from interface: MessageBuilder
      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.
      Specified by:
      build in interface MessageBuilder
      Returns:
      the message