Package io.bdeploy.common

Class ActivityReporter.Null

java.lang.Object

io.bdeploy.common.ActivityReporter.Null

All Implemented Interfaces:

ActivityReporter

Enclosing interface:

ActivityReporter

public static class ActivityReporter.Null
extends Object
implements ActivityReporter

No-op ActivityReporter, which does nothing, except being null.

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
Null()

Method Summary

Modifier and Type	Method	Description
NoThrowAutoCloseable	proxyActivities(RemoteService service)	Proxy remote activities to this ActivityReporter implementation if possible.
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.

Methods inherited from class java.lang.Object

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

Constructor Details

Null

public Null()

Method Details

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

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