Package io.bdeploy.common

Class ActivityReporter.Stream

java.lang.Object

io.bdeploy.common.ActivityReporter.Stream

All Implemented Interfaces:

ActivityReporter

Enclosing interface:

ActivityReporter

public static final class ActivityReporter.Stream
extends Object
implements ActivityReporter

An ActivityReporter implementation which reports progress to a given PrintStream.

Nested Class Summary

Nested classes/interfaces inherited from interface io.bdeploy.common.ActivityReporter

ActivityReporter.Activity, ActivityReporter.ActivityCancelledException, ActivityReporter.Delegating, ActivityReporter.Null, ActivityReporter.Stream

Constructor Summary

Constructors

Constructor	Description
Stream(PrintStream output)

Method Summary

Modifier and Type	Method	Description
void	beginReporting()	Begins the reporting process.
NoThrowAutoCloseable	proxyActivities(RemoteService service)	Proxy remote activities to this ActivityReporter implementation if possible.
void	setProxyConnector(BiFunction<RemoteService,Consumer<List<ActivitySnapshot>>,NoThrowAutoCloseable> proxyConnector)
void	setVerboseSummary(boolean verbose)	A verbose summary will include more details about single activity duration(s).
ActivityReporter.Activity	start(String activity)	Start an ActivityReporter.Activity without any associated work amount.
ActivityReporter.Activity	start(String activity, long maxWork)	Start an ActivityReporter.Activity with a static work amount.
ActivityReporter.Activity	start(String activity, LongSupplier maxValue, LongSupplier currentValue)	Start an ActivityReporter.Activity with a dynamic maximum and current work amount.
void	stopReporting()	Stops (and cleans up resources associated with) progress reporting.

Methods inherited from class java.lang.Object

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

Constructor Details

Stream

public Stream(PrintStream output)

Method Details

setVerboseSummary

public void setVerboseSummary(boolean verbose)

A verbose summary will include more details about single activity duration(s).

beginReporting

public void beginReporting()

Begins the reporting process. Reporting runs asynchronously (periodically) to avoid stalling of running actions while catching up with dynamic updates to progress values.

stopReporting

public void stopReporting()

Stops (and cleans up resources associated with) progress reporting. No further ActivityReporter.Activity processing will be done after this method finishes. All remaining ActivityReporter.Activity instances are cleared (but not finished).

start

public ActivityReporter.Activity start(String activity)

Description copied from interface: ActivityReporter

Start an ActivityReporter.Activity without any associated work amount.

Specified by:

start in interface ActivityReporter

start

public ActivityReporter.Activity start(String activity,
 long maxWork)

Description copied from interface: ActivityReporter

Start an ActivityReporter.Activity with a static work amount. Use ActivityReporter.Activity.worked(long) to updated the already consumed work amount.

Special maxWork values:

• -1: don't report work at all. only time will be reported
• 0: don't report any maximum, just report current amount if possible.

Specified by:

start in interface ActivityReporter

start

public ActivityReporter.Activity start(String activity,
 LongSupplier maxValue,
 LongSupplier currentValue)

Description copied from interface: ActivityReporter

Start an ActivityReporter.Activity with a dynamic maximum and current work amount. The Suppliers are queried periodically when reporting progress, to catch updates on the values.

Specified by:

start in interface ActivityReporter

setProxyConnector

public void setProxyConnector(BiFunction<RemoteService,Consumer<List<ActivitySnapshot>>,NoThrowAutoCloseable> proxyConnector)

proxyActivities

public NoThrowAutoCloseable proxyActivities(RemoteService service)

Description copied from interface: ActivityReporter

Proxy remote activities to this ActivityReporter implementation if possible.

Specified by:

proxyActivities in interface ActivityReporter