org.gradle.logging

Interface StyledTextOutput

All Superinterfaces:

Appendable

All Known Subinterfaces:

TextArea

All Known Implementing Classes:

AbstractLineChoppingStyledTextOutput, AbstractStyledTextOutput, BufferingStyledTextOutput, LinePrefixingStyledTextOutput, LoggingBackedStyledTextOutput, StreamingStyledTextOutput

public interface StyledTextOutput
extends Appendable

Provides streaming of styled text, that is, a stream of text with inline styling information. Implementations are not required to be thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StyledTextOutput.Style

Method Summary

Methods

Modifier and Type	Method and Description
StyledTextOutput	append(char c) Appends a character using the current style.
StyledTextOutput	append(CharSequence csq) Appends a sequence of characters using the current style.
StyledTextOutput	append(CharSequence csq, int start, int end) Appends a sequence of characters using the current style.
StyledTextOutput	exception(Throwable throwable) Appends the stacktrace of the given exception using the current style.
StyledTextOutput	format(String pattern, Object... args) Appends a formatted string using the current style.
StyledTextOutput	formatln(String pattern, Object... args) Appends a formatted string using the current style and starts a new line.
StyledTextOutput	println() Starts a new line.
StyledTextOutput	println(Object text) Appends text using the current style and starts a new line.
StyledTextOutput	style(StyledTextOutput.Style style) Switches to a new style.
StyledTextOutput	text(Object text) Appends text using the current style.
StyledTextOutput	withStyle(StyledTextOutput.Style style) Creates a copy of this output which uses the given style.

Method Detail

append

StyledTextOutput append(char c)

Appends a character using the current style.

Specified by:

append in interface Appendable

Parameters:

c - The character

Returns:

this

append

StyledTextOutput append(CharSequence csq)

Appends a sequence of characters using the current style.

Specified by:

append in interface Appendable

Parameters:

csq - The character sequence

Returns:

this.

append

StyledTextOutput append(CharSequence csq,
                      int start,
                      int end)

Appends a sequence of characters using the current style.

Specified by:

append in interface Appendable

Parameters:

csq - The character sequence

Returns:

this.

style

StyledTextOutput style(StyledTextOutput.Style style)

Switches to a new style. The default style is StyledTextOutput.Style.Normal.

Parameters:

style - The style.

Returns:

this

withStyle

StyledTextOutput withStyle(StyledTextOutput.Style style)

Creates a copy of this output which uses the given style. This can be used to generate text in a different style and then return to the current style. For example:

 output.style(Info)
 output.withStyle(Description).format("%s %s", name, description) // output in Description style
 output.println(" text") // output in Info style
 

Parameters:

style - The temporary style

Returns:

the copy

text

StyledTextOutput text(Object text)

Appends text using the current style.

Parameters:

text - The text

Returns:

this

println

StyledTextOutput println(Object text)

Appends text using the current style and starts a new line.

Parameters:

text - The text

Returns:

this

format

StyledTextOutput format(String pattern,
                      Object... args)

Appends a formatted string using the current style.

Parameters:

pattern - The pattern string

args - The args for the pattern

Returns:

this

formatln

StyledTextOutput formatln(String pattern,
                        Object... args)

Appends a formatted string using the current style and starts a new line.

Parameters:

pattern - The pattern string

args - The args for the pattern

Returns:

this

println

StyledTextOutput println()

Starts a new line.

Returns:

this

exception

StyledTextOutput exception(Throwable throwable)

Appends the stacktrace of the given exception using the current style.

Parameters:

throwable - The exception

Returns:

this