org.apache.maven.api.services

Interface MessageBuilder

All Known Implementing Classes:

DefaultMessageBuilder

public interface MessageBuilder

Message builder that supports configurable styling.

Since:

4.0

See Also:

MessageBuilderFactory

Method Summary

Modifier and Type	Method and Description
MessageBuilder	a(char[] value) Append content to the message buffer.
MessageBuilder	a(char[] value, int offset, int len) Append content to the message buffer.
MessageBuilder	a(CharSequence value) Append content to the message buffer.
MessageBuilder	a(CharSequence value, int start, int end) Append content to the message buffer.
MessageBuilder	a(Object value) Append content to the message buffer.
String	build() Return the built message.
MessageBuilder	failure(Object message) Append message content in failure style.
MessageBuilder	format(String pattern, Object... args) Append formatted content to the buffer.
MessageBuilder	mojo(Object message) Append message content in mojo style.
MessageBuilder	newline() Append newline to the message buffer.
MessageBuilder	project(Object message) Append message content in project style.
MessageBuilder	strong(Object message) Append message content in strong style.
MessageBuilder	success(Object message) Append message content in success style.
MessageBuilder	warning(Object message) Append message content in warning style.

Method Detail

success

@Nonnull
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

@Nonnull
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

@Nonnull
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

@Nonnull
MessageBuilder strong(Object message)

Append message content in strong style. By default, bold

Parameters:

message - the message to append

Returns:

the current builder

mojo

@Nonnull
MessageBuilder mojo(Object message)

Append message content in mojo style. By default, green

Parameters:

message - the message to append

Returns:

the current builder

project

@Nonnull
MessageBuilder project(Object message)

Append message content in project style. By default, cyan

Parameters:

message - the message to append

Returns:

the current builder

a

@Nonnull
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

@Nonnull
MessageBuilder a(char[] value)

Append content to the message buffer.

Parameters:

value - the content to append

Returns:

the current builder

a

@Nonnull
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

@Nonnull
MessageBuilder a(CharSequence value)

Append content to the message buffer.

Parameters:

value - the content to append

Returns:

the current builder

a

@Nonnull
MessageBuilder a(Object value)

Append content to the message buffer.

Parameters:

value - the content to append

Returns:

the current builder

newline

@Nonnull
MessageBuilder newline()

Append newline to the message buffer.

Returns:

the current builder

format

@Nonnull
MessageBuilder format(String pattern,
                               Object... args)

Append formatted content to the buffer.

Parameters:

pattern - a format string

args - arguments referenced by the format specifiers in the format string.

Returns:

the current builder

See Also:

String.format(String, Object...)

build

@Nonnull
String build()

Return the built message.

Returns:

the message