org.jboss.dna.common.monitor
Class ProgressStatus

java.lang.Object
  org.jboss.dna.common.monitor.ProgressStatus

All Implemented Interfaces:

Serializable, Comparable<ProgressStatus>

@Immutable
public class ProgressStatus
extends Object
implements Serializable, Comparable<ProgressStatus>

A snapshot of the progress on an activity.

Author:

Randall Hauch

See Also:

Serialized Form

Field Summary

protected static double	PERCENT_PRECISION
protected static String	PERCENTAGE_PATTERN

Constructor Summary

ProgressStatus(String activityName, String message, double percentWorked, boolean cancelled)
Create the progress status.

ProgressStatus(String activityName, String message, double workedSoFar, double totalWork, boolean cancelled)
Create the progress status and compute the percentage worked.

Method Summary

int	compareTo(ProgressStatus that)
protected static double	computePercentage(double workedSoFar, double totalWork) Compute the percentage worked, accounting for imprecision in
boolean	equals(Object obj)
String	getActivityName() Get the name of the activity.
String	getMessage() Get the progress monitor's text message.
double	getPercentWorked() Get the progress as a percentage of the total work that's been completed.
int	hashCode()
boolean	isCancelled() Return whether the activity was requested to be cancelled.
boolean	isDone() Return whether work on this activity has completed.
protected static boolean	isSamePercentage(double percentage1, double percentage2)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PERCENTAGE_PATTERN

protected static final String PERCENTAGE_PATTERN

See Also:

Constant Field Values

PERCENT_PRECISION

protected static final double PERCENT_PRECISION

See Also:

Constant Field Values

Constructor Detail

ProgressStatus

public ProgressStatus(String activityName,
                      String message,
                      double percentWorked,
                      boolean cancelled)

Create the progress status.

Parameters:

activityName - the name of the activity, which may not be null

message - the message for the progress, which may not be null

percentWorked - the percentage worked, ranging from 0.0 for not started to 100.0 for complete; a negative value are treated as 0.0, while a value greater than 100.0 is treated as 100.0

cancelled - true if the activity has been requested to be cancelled, or false otherwise

ProgressStatus

public ProgressStatus(String activityName,
                      String message,
                      double workedSoFar,
                      double totalWork,
                      boolean cancelled)

Create the progress status and compute the percentage worked.

Parameters:

activityName - the name of the activity, which may not be null

message - the message for the progress, which may not be null

workedSoFar - the amount of work so far percentage worked

totalWork - the total amount of work for this activity

cancelled - true if the activity has been requested to be cancelled, or false otherwise

Method Detail

computePercentage

protected static double computePercentage(double workedSoFar,
                                          double totalWork)

Compute the percentage worked, accounting for imprecision in

Parameters:

workedSoFar - the amount of work so far percentage worked

totalWork - the total amount of work for this activity

Returns:

the percentage worked

isSamePercentage

protected static boolean isSamePercentage(double percentage1,
                                          double percentage2)

getActivityName

public String getActivityName()

Get the name of the activity.

Returns:

the activity's name

getPercentWorked

public double getPercentWorked()

Get the progress as a percentage of the total work that's been completed.

Returns:

the percentage worked, ranging from 0.0 to 100.0

getMessage

public String getMessage()

Get the progress monitor's text message.

Returns:

the text message

isDone

public boolean isDone()

Return whether work on this activity has completed.

Returns:

true if work has completed, or false if work on the activity is still progressing

See Also:

isCancelled()

isCancelled

public boolean isCancelled()

Return whether the activity was requested to be cancelled.

Returns:

cancelled

See Also:

isDone()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ProgressStatus that)

Specified by:

compareTo in interface Comparable<ProgressStatus>