com.google.cloud.tools.jib.builder

Class ProgressEventDispatcher

java.lang.Object

com.google.cloud.tools.jib.builder.ProgressEventDispatcher

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProgressEventDispatcher
extends Object
implements Closeable

Dispatches ProgressEvents associated with a managed Allocation. Keeps track of the allocation units that are remaining so that it can emit the remaining progress units upon close().

This class is not thread-safe. Only use a single instance per thread and create child instances with newChildProducer().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressEventDispatcher.Factory Creates a new ProgressEventDispatcher based off an existing ProgressEventDispatcher.

Method Summary

Modifier and Type	Method and Description
void	close() Emits the remaining allocation units as progress units in a ProgressEvent.
void	dispatchProgress(long progressUnits) Dispatches a ProgressEvent representing progressUnits of progress on the managed allocation.
ProgressEventDispatcher.Factory	newChildProducer() Creates a new ProgressEventDispatcher.Factory for a ProgressEventDispatcher that manages a child Allocation.
static ProgressEventDispatcher	newRoot(EventHandlers eventHandlers, String description, long allocationUnits) Creates a new ProgressEventDispatcher with a root Allocation.

Methods inherited from class java.lang.Object

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

Method Detail

newRoot

public static ProgressEventDispatcher newRoot(EventHandlers eventHandlers,
                                              String description,
                                              long allocationUnits)

Creates a new ProgressEventDispatcher with a root Allocation.

Parameters:

eventHandlers - the EventHandlers

description - user-facing description of what the allocation represents

allocationUnits - number of allocation units

Returns:

a new ProgressEventDispatcher

newChildProducer

public ProgressEventDispatcher.Factory newChildProducer()

Creates a new ProgressEventDispatcher.Factory for a ProgressEventDispatcher that manages a child Allocation. Since each child Allocation accounts for 1 allocation unit of its parent, this method decrements the remainingAllocationUnits by 1.

Returns:

a new ProgressEventDispatcher.Factory

close

public void close()

Emits the remaining allocation units as progress units in a ProgressEvent.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

dispatchProgress

public void dispatchProgress(long progressUnits)

Dispatches a ProgressEvent representing progressUnits of progress on the managed allocation.

Parameters:

progressUnits - units of progress