Package org.springframework.boot.buildpack.platform.docker

Class TotalProgressListener<E extends ImageProgressUpdateEvent>

java.lang.Object

org.springframework.boot.buildpack.platform.docker.TotalProgressListener<E>

Type Parameters:

E - the type of ImageProgressUpdateEvent

All Implemented Interfaces:

UpdateListener<E>

Direct Known Subclasses:

TotalProgressPullListener, TotalProgressPushListener

public abstract class TotalProgressListener<E extends ImageProgressUpdateEvent>
extends Object
implements UpdateListener<E>

UpdateListener that calculates the total progress of the entire image operation and publishes TotalProgressEvent.

Since:

2.4.0

Author:

Phillip Webb, Scott Frederick

Field Summary

Fields inherited from interface org.springframework.boot.buildpack.platform.docker.UpdateListener

NONE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TotalProgressListener(Consumer<TotalProgressEvent> consumer, String[] trackedStatusKeys)	Create a new TotalProgressListener that sends events to the given consumer.

Method Summary

Modifier and Type	Method	Description
void	onFinish()	Called when the operation finishes (with or without error).
void	onStart()	Called when the operation starts.
void	onUpdate(E event)	Called when an update event is available.

Methods inherited from class java.lang.Object

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

Constructor Details

TotalProgressListener

protected TotalProgressListener(Consumer<TotalProgressEvent> consumer,
 String[] trackedStatusKeys)

Create a new TotalProgressListener that sends events to the given consumer.

Parameters:

consumer - the consumer that receives progress events

trackedStatusKeys - a list of status event keys to track the progress of

Method Details

onStart

public void onStart()

Description copied from interface: UpdateListener

Called when the operation starts.

Specified by:

onStart in interface UpdateListener<E extends ImageProgressUpdateEvent>

onUpdate

public void onUpdate(E event)

Description copied from interface: UpdateListener

Called when an update event is available.

Specified by:

onUpdate in interface UpdateListener<E extends ImageProgressUpdateEvent>

Parameters:

event - the update event

onFinish

public void onFinish()

Description copied from interface: UpdateListener

Called when the operation finishes (with or without error).

Specified by:

onFinish in interface UpdateListener<E extends ImageProgressUpdateEvent>