org.gradle.logging

Interface ProgressLogger

public interface ProgressLogger

Used to log the progress of a potentially long running operation.

When running in the command-line UI, the properties of an operation are treated as follows:

• When an operation starts, and the operation has a logging header defined, a LIFECYCLE log message is generated containing the logging header. If running under a terminal, and the logging header == the short description or the status, this log message is deferred until either some other log message is generated or the operation completes.
• If running under a terminal, and the operation has a status defined, that status is shown in the 'status bar' at the bottom of the screen.
• If running under a terminal, and the operation has a short description and no status defined, the short description is shown in the 'status bar' at the bottom of the screen.

Method Summary

Methods

Modifier and Type	Method and Description
void	completed() Logs the completion of the operation, with no final status
void	completed(String status) Logs the completion of the operation, with a final status.
String	getDescription() Returns the description of the operation.
String	getLoggingHeader() Returns the logging header for the operation.
String	getShortDescription() Returns the short description of the operation.
void	progress(String status) Logs some progress, indicated by a new status.
void	setDescription(String description) Sets the description of the operation.
void	setLoggingHeader(String header) Sets the logging header for the operation.
void	setShortDescription(String description) Sets the short description of the operation.
void	started() Logs the start of the operation, with no initial status.
void	started(String status) Logs the start of the operation, with the given status.

Method Detail

getDescription

String getDescription()

Returns the description of the operation.

Returns:

the description, must not be empty.

setDescription

void setDescription(String description)

Sets the description of the operation. This should be a full, stand-alone description of the operation.

This must be called before started().

Parameters:

description - The description.

getShortDescription

String getShortDescription()

Returns the short description of the operation. This is used in place of the full description when display space is limited.

Returns:

The short description, must not be empty.

setShortDescription

void setShortDescription(String description)

Sets the short description of the operation. This is used in place of the full description when display space is limited.

This must be called before started()

Parameters:

description - The short description.

getLoggingHeader

String getLoggingHeader()

Returns the logging header for the operation. This is logged before any other log messages for this operation are logged. It is usually also logged at the end of the operation, along with the final status message. Defaults to null.

If not specified, no logging header is logged.

Returns:

The logging header, possibly empty.

setLoggingHeader

void setLoggingHeader(String header)

Sets the logging header for the operation. This is logged before any other log messages for this operation are logged. It is usually also logged at the end of the operation, along with the final status message. Defaults to null.

Parameters:

header - The header. May be empty or null.

started

void started()

Logs the start of the operation, with no initial status.

started

void started(String status)

Logs the start of the operation, with the given status.

Parameters:

status - The initial status message. Can be null or empty.

progress

void progress(String status)

Logs some progress, indicated by a new status.

Parameters:

status - The new status message. Can be null or empty.

completed

void completed()

Logs the completion of the operation, with no final status

completed

void completed(String status)

Logs the completion of the operation, with a final status. This is generally logged along with the description.

Parameters:

status - The final status message. Can be null or empty.