com.vmware.vapi.std

Class Progress

java.lang.Object

com.vmware.vapi.std.Progress

public final class Progress
extends Object

Progress notification which is emitted by a running operation.

Progress can be either determinate or indeterminate. Determinate progress gives an estimate of how much work is already done and how much more work remains. Indeterminate progress means that progress is being made but it is not clear how much more work remains. For determinate progress getMin() is strictly less than getMax() and getCurrent() is a value in the closed interval from getMin() to getMax(). For indeterminate progress getMin() must be equal to getMax() and getCurrent() is any non-negative value.

The same determinate progress can be represented in multiple ways (all semantically equivalent). For example 50% progress can be represented as (min=0, max=100, current=50) or (min=0, max=10, current=5) or (min=0, max=4, current=2) etc.

The order of progress notifications is not guaranteed. The consumer of progress notifications should ignore progress notifications that go backwards (i.e. decreasing current progress value).

Constructor Summary

Constructors

Constructor and Description
Progress(long min, long max, long current) Creates a progress notification.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getCurrent()
long	getMax()
long	getMin()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Progress

public Progress(long min,
                long max,
                long current)

Creates a progress notification.

Parameters:

min - minimum value in the progress range; must be non-negative

max - maximum value in the progress range; must be non-negative

current - current progress value; must be non-negative

Throws:

IllegalArgumentException - if the field values are invalid

Method Detail

getMin

public long getMin()

Returns:

minimum value in the progress range

getMax

public long getMax()

Returns:

maximum value in the progress range

getCurrent

public long getCurrent()

Returns:

current progress value

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object