org.eth.cyril.util

Class ProgressMonitor.Progress

java.lang.Object

org.eth.cyril.util.ProgressMonitor.Progress

Enclosing interface:

ProgressMonitor

public static class ProgressMonitor.Progress
extends java.lang.Object

Describes the progress which was made.

Method Summary

Modifier and Type	Method and Description
static ProgressMonitor.Progress	cancelled(int totalSteps, long id) Returns a new progress to indicate that the action was cancelled.
long	getId() Returns an ID uniquely identifying a set of progress objects which belong together.
java.lang.String	getNextStepDescription() Get the description of the next step.
double	getPercent() Returns how many percent of the work have been completed, according to how many steps were performed and how many there are in total.
int	getStepsPerformed() Returns the number of steps performed so far.
int	getTotalSteps() Get the total number of steps.
boolean	isCancelled() Returns whether the monitored action was cancelled.
boolean	isCompleted() Returns whether the progress is completed, therefore the operation behind is finished.
static ProgressMonitor.Progress	withNextStepDescription(int stepsPerformed, int totalSteps, java.lang.String nextStepDescription, long id) Creates a new progress instance with a description of the next step.
static ProgressMonitor.Progress	withoutNextStepDescription(int stepsPerformed, int totalSteps, long id) Creates a new progress instance without a description of the next step.

Methods inherited from class java.lang.Object

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

Method Detail

withNextStepDescription

public static ProgressMonitor.Progress withNextStepDescription(int stepsPerformed,
                                                               int totalSteps,
                                                               java.lang.String nextStepDescription,
                                                               long id)

Creates a new progress instance with a description of the next step.

Parameters:

stepsPerformed - The number of steps performed so far. Must be in the range [0, totalSteps].

totalSteps - The total number of steps to be performed.

nextStepDescription - The description of the next step. May not be null.

id - A unique identifier for the progress object. The identifier allows to group multiple progress objects from the same computation step together. The identifier must be unique in the sense that the combination of identifier + sender of this object is unique. Therefore multiple progress senders may send the same id.

Returns:

A new progress instance with a description of the next step.

withoutNextStepDescription

public static ProgressMonitor.Progress withoutNextStepDescription(int stepsPerformed,
                                                                  int totalSteps,
                                                                  long id)

Creates a new progress instance without a description of the next step.

Parameters:

stepsPerformed - The number of steps performed so far. Must be in the range [0, totalSteps].

totalSteps - The total number of steps to be performed.

id - A unique identifier for the progress object. The identifier allows to group multiple progress objects from the same computation step together. The identifier must be unique in the sense that the combination of identifier + sender of this object is unique. Therefore multiple progress senders may send the same id.

Returns:

A new progress instance without a description of the next step.

cancelled

public static ProgressMonitor.Progress cancelled(int totalSteps,
                                                 long id)

Returns a new progress to indicate that the action was cancelled.

Parameters:

totalSteps - The total number of steps to be performed.

id - A unique identifier for the progress object. The identifier allows to group multiple progress objects from the same computation step together. The identifier must be unique in the sense that the combination of identifier + sender of this object is unique. Therefore multiple progress senders may send the same id.

Returns:

A new progress instance to indicate that the action was cancelled

getStepsPerformed

public int getStepsPerformed()

Returns the number of steps performed so far.

getTotalSteps

public int getTotalSteps()

Get the total number of steps.

getNextStepDescription

public java.lang.String getNextStepDescription()

Get the description of the next step. May be left empty (as an empty string), but will not be null.

getPercent

public double getPercent()

Returns how many percent of the work have been completed, according to how many steps were performed and how many there are in total.

isCancelled

public boolean isCancelled()

Returns whether the monitored action was cancelled. Cancelled actions are always given at full progress.

isCompleted

public boolean isCompleted()

Returns whether the progress is completed, therefore the operation behind is finished.

getId

public long getId()

Returns an ID uniquely identifying a set of progress objects which belong together. Progress objects from the same sender with the same ID come from the same computation.