org.gradle.logging.internal

Class AbstractStyledTextOutput

java.lang.Object

org.gradle.logging.internal.AbstractStyledTextOutput

All Implemented Interfaces:

Appendable, StandardOutputListener, StyledTextOutput

Direct Known Subclasses:

AbstractLineChoppingStyledTextOutput, BufferingStyledTextOutput, LoggingBackedStyledTextOutput, StreamingStyledTextOutput

public abstract class AbstractStyledTextOutput
extends Object
implements StyledTextOutput, StandardOutputListener

Subclasses need to implement doAppend(String), and optionally doStyleChange(org.gradle.logging.StyledTextOutput.Style).

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.logging.StyledTextOutput

StyledTextOutput.Style

Constructor Summary

Constructors

Constructor and Description
AbstractStyledTextOutput()

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.
protected abstract void	doAppend(String text)
protected void	doStyleChange(StyledTextOutput.Style 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.Style	getStyle()
void	onOutput(CharSequence output) Called when some output is written by the logging system.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStyledTextOutput

public AbstractStyledTextOutput()

Method Detail

append

public StyledTextOutput append(char c)

Description copied from interface: StyledTextOutput

Appends a character using the current style.

Specified by:

append in interface Appendable

Specified by:

append in interface StyledTextOutput

Parameters:

c - The character

Returns:

this

append

public StyledTextOutput append(CharSequence csq)

Description copied from interface: StyledTextOutput

Appends a sequence of characters using the current style.

Specified by:

append in interface Appendable

Specified by:

append in interface StyledTextOutput

Parameters:

csq - The character sequence

Returns:

this.

append

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

Description copied from interface: StyledTextOutput

Appends a sequence of characters using the current style.

Specified by:

append in interface Appendable

Specified by:

append in interface StyledTextOutput

Parameters:

csq - The character sequence

Returns:

this.

format

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

Description copied from interface: StyledTextOutput

Appends a formatted string using the current style.

Specified by:

format in interface StyledTextOutput

Parameters:

pattern - The pattern string

args - The args for the pattern

Returns:

this

println

public StyledTextOutput println(Object text)

Description copied from interface: StyledTextOutput

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

Specified by:

println in interface StyledTextOutput

Parameters:

text - The text

Returns:

this

formatln

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

Description copied from interface: StyledTextOutput

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

Specified by:

formatln in interface StyledTextOutput

Parameters:

pattern - The pattern string

args - The args for the pattern

Returns:

this

onOutput

public void onOutput(CharSequence output)

Description copied from interface: StandardOutputListener

Called when some output is written by the logging system.

Specified by:

onOutput in interface StandardOutputListener

Parameters:

output - The text.

println

public StyledTextOutput println()

Description copied from interface: StyledTextOutput

Starts a new line.

Specified by:

println in interface StyledTextOutput

Returns:

this

text

public StyledTextOutput text(Object text)

Description copied from interface: StyledTextOutput

Appends text using the current style.

Specified by:

text in interface StyledTextOutput

Parameters:

text - The text

Returns:

this

exception

public StyledTextOutput exception(Throwable throwable)

Description copied from interface: StyledTextOutput

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

Specified by:

exception in interface StyledTextOutput

Parameters:

throwable - The exception

Returns:

this

withStyle

public StyledTextOutput withStyle(StyledTextOutput.Style style)

Description copied from interface: StyledTextOutput

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
 

Specified by:

withStyle in interface StyledTextOutput

Parameters:

style - The temporary style

Returns:

the copy

style

public StyledTextOutput style(StyledTextOutput.Style style)

Description copied from interface: StyledTextOutput

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

Specified by:

style in interface StyledTextOutput

Parameters:

style - The style.

Returns:

this

getStyle

public StyledTextOutput.Style getStyle()

doAppend

protected abstract void doAppend(String text)

doStyleChange

protected void doStyleChange(StyledTextOutput.Style style)