org.springframework.boot.buildpack.platform.docker

Class TotalProgressPullListener

java.lang.Object

org.springframework.boot.buildpack.platform.docker.TotalProgressPullListener

All Implemented Interfaces:

UpdateListener<PullImageUpdateEvent>

public class TotalProgressPullListener
extends java.lang.Object
implements UpdateListener<PullImageUpdateEvent>

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

Since:

2.3.0

Field Summary

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

NONE

Constructor Summary

Constructors

Constructor and Description
TotalProgressPullListener(java.util.function.Consumer<TotalProgressEvent> consumer) Create a new TotalProgressPullListener that sends events to the given consumer.
TotalProgressPullListener(java.lang.String prefix) Create a new TotalProgressPullListener that prints a progress bar to System.out.

Method Summary

Modifier and Type	Method and Description
void	onFinish() Called when the operation finishes (with or without error).
void	onStart() Called when the operation starts.
void	onUpdate(PullImageUpdateEvent 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

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

none

Constructor Detail

TotalProgressPullListener

public TotalProgressPullListener(java.lang.String prefix)

Create a new TotalProgressPullListener that prints a progress bar to System.out.

Parameters:

prefix - the prefix to output

TotalProgressPullListener

public TotalProgressPullListener(java.util.function.Consumer<TotalProgressEvent> consumer)

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

Parameters:

consumer - the consumer that receives progress events

Method Detail

onStart

public void onStart()

Description copied from interface: UpdateListener

Called when the operation starts.

Specified by:

onStart in interface UpdateListener<PullImageUpdateEvent>

onUpdate

public void onUpdate(PullImageUpdateEvent event)

Description copied from interface: UpdateListener

Called when an update event is available.

Specified by:

onUpdate in interface UpdateListener<PullImageUpdateEvent>

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<PullImageUpdateEvent>