Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.core.io
Interface ProgressIndicator

All Known Implementing Classes:
LogProgressIndicator, NullProgressIndicator, ProgressIndicatorDecorator, ProgressMonitorIndicator, SubtaskProgressIndicator

public interface ProgressIndicator

Progress indicator

Since:
2.2
Author:
Simon Templer
Partner:
01 / Fraunhofer Institute for Computer Graphics Research

Field Summary
static int UNKNOWN
          Unknown amount of work units
 
Method Summary
 void advance(int workUnits)
          Advances the progress by the given work units
 void begin(String taskName, int totalWork)
          Start the progress tracking
 void end()
          Stop the progress tracking, signaling that the task is done
 boolean isCanceled()
          States if the execution was canceled
 void setCurrentTask(String taskName)
          Sets the current task name
 

Field Detail

UNKNOWN

static final int UNKNOWN
Unknown amount of work units

See Also:
Constant Field Values
Method Detail

begin

void begin(String taskName,
           int totalWork)
Start the progress tracking

Parameters:
taskName - the main task name
totalWork - the total work units for the progress indicator, if unknown use UNKNOWN

setCurrentTask

void setCurrentTask(String taskName)
Sets the current task name

Parameters:
taskName - the task name

advance

void advance(int workUnits)
Advances the progress by the given work units

Parameters:
workUnits - the work units

isCanceled

boolean isCanceled()
States if the execution was canceled

Returns:
if the execution was canceled

end

void end()
Stop the progress tracking, signaling that the task is done


Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d