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 java.lang.Object
implements MessageBuilder, LoggerLevelRenderer

Message builder implementation that supports ANSI colors through Jansi with configurable styles through Style.

Field Summary

Fields

Modifier and Type	Field	Description
private org.fusesource.jansi.Ansi	ansi

Constructor Summary

Constructors

Constructor	Description
AnsiMessageBuilder()
AnsiMessageBuilder(int size)
AnsiMessageBuilder(java.lang.StringBuilder builder)
AnsiMessageBuilder(org.fusesource.jansi.Ansi ansi)

Method Summary

Modifier and Type	Method	Description
AnsiMessageBuilder	a(char[] value)	Append content to the message buffer.
AnsiMessageBuilder	a(char[] value, int offset, int len)	Append content to the message buffer.
AnsiMessageBuilder	a(java.lang.CharSequence value)	Append content to the message buffer.
AnsiMessageBuilder	a(java.lang.CharSequence value, int start, int end)	Append content to the message buffer.
AnsiMessageBuilder	a(java.lang.Object value)	Append content to the message buffer.
java.lang.String	build()	Get the message constructed by this builder.
java.lang.String	debug(java.lang.String message)	Render a message at DEBUG level.
java.lang.String	error(java.lang.String message)	Render a message at ERROR level.
AnsiMessageBuilder	failure(java.lang.Object message)	Append message content in failure style.
AnsiMessageBuilder	format(java.lang.String pattern, java.lang.Object... args)	Append formatted content to the buffer.
java.lang.String	info(java.lang.String message)	Render a message at INFO level.
AnsiMessageBuilder	mojo(java.lang.Object message)	Append message content in mojo style.
AnsiMessageBuilder	newline()	Append newline to the message buffer.
AnsiMessageBuilder	project(java.lang.Object message)	Append message content in project style.
AnsiMessageBuilder	strong(java.lang.Object message)	Append message content in strong style.
AnsiMessageBuilder	success(java.lang.Object message)	Append message content in success style.
java.lang.String	toString()	Same as MessageBuilder.build().
AnsiMessageBuilder	warning(java.lang.Object message)	Append message content in warning style.
java.lang.String	warning(java.lang.String message)	Render a message at WARNING level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ansi

private org.fusesource.jansi.Ansi ansi

Constructor Detail

AnsiMessageBuilder

AnsiMessageBuilder()

AnsiMessageBuilder

AnsiMessageBuilder(java.lang.StringBuilder builder)

AnsiMessageBuilder

AnsiMessageBuilder(int size)

AnsiMessageBuilder

AnsiMessageBuilder(org.fusesource.jansi.Ansi ansi)

Method Detail

debug

public java.lang.String debug(java.lang.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 java.lang.String info(java.lang.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 java.lang.String warning(java.lang.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 java.lang.String error(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String pattern,
                                 java.lang.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:

String.format(String, Object...)

toString

public java.lang.String toString()

Description copied from interface: MessageBuilder

Same as MessageBuilder.build().

Specified by:

toString in interface MessageBuilder

Overrides:

toString in class java.lang.Object

build

public java.lang.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