org.springframework.boot.buildpack.platform.docker

Interface UpdateListener<E extends UpdateEvent>

Type Parameters:

E - the update event type

All Known Implementing Classes:

TotalProgressListener, TotalProgressPullListener, TotalProgressPushListener

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface UpdateListener<E extends UpdateEvent>

Listener for update events published from the DockerApi.

Since:

2.3.0

Author:

Phillip Webb

Field Summary

Fields

Modifier and Type	Field and Description
static UpdateListener<UpdateEvent>	NONE A no-op update listener.

Method Summary

Modifier and Type	Method and Description
static <E extends UpdateEvent> UpdateListener<E>	none() A no-op update listener that does nothing.
default void	onFinish() Called when the operation finishes (with or without error).
default void	onStart() Called when the operation starts.
void	onUpdate(E event) Called when an update event is available.

Field Detail

NONE

static final UpdateListener<UpdateEvent> NONE

A no-op update listener.

See Also:

none()

Method Detail

onStart

default void onStart()

Called when the operation starts.

onUpdate

void onUpdate(E event)

Called when an update event is available.

Parameters:

event - the update event

onFinish

default void onFinish()

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

none

static <E extends UpdateEvent> UpdateListener<E> none()

A no-op update listener that does nothing.

Type Parameters:

E - the event type

Returns:

a no-op update listener