public interface ProgressLogger
When running in the command-line UI, the properties of an operation are treated as follows:
| 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.
|
String getDescription()
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().
description - The description.String getShortDescription()
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()
description - The short description.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.
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.
header - The header. May be empty or null.void started()
void started(String status)
status - The initial status message. Can be null or empty.void progress(String status)
status - The new status message. Can be null or empty.void completed()
void completed(String status)
status - The final status message. Can be null or empty.Copyright © 2013. All rights reserved