Class ProgressUpdateEvent

java.lang.Object

org.springframework.boot.buildpack.platform.docker.UpdateEvent

org.springframework.boot.buildpack.platform.docker.ProgressUpdateEvent

Direct Known Subclasses:

ImageProgressUpdateEvent, LoadImageUpdateEvent

public abstract class ProgressUpdateEvent
extends UpdateEvent

An UpdateEvent that includes progress information.

Since:

2.3.0

Author:

Phillip Webb, Wolfgang Kronberg

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgressUpdateEvent.ProgressDetail	Provide details about the progress of a task.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProgressUpdateEvent(@Nullable String status, @Nullable ProgressUpdateEvent.ProgressDetail progressDetail, @Nullable String progress)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getProgress()	Return a text based progress bar if progress information is available.
@Nullable ProgressUpdateEvent.ProgressDetail	getProgressDetail()	Return progress details if available.
@Nullable String	getStatus()	Return the status for the update.

Methods inherited from class Object

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

Constructor Details

ProgressUpdateEvent

protected ProgressUpdateEvent(@Nullable String status,
 @Nullable ProgressUpdateEvent.ProgressDetail progressDetail,
 @Nullable String progress)

Method Details

getStatus

public @Nullable String getStatus()

Return the status for the update. For example, "Extracting" or "Downloading".

Returns:

the status of the update.

getProgressDetail

public @Nullable ProgressUpdateEvent.ProgressDetail getProgressDetail()

Return progress details if available.

Returns:

progress details or null

getProgress

public @Nullable String getProgress()

Return a text based progress bar if progress information is available.

Returns:

the progress bar or null