Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.server.progress.impl
Class ProgressMonitor

java.lang.Object
  extended by eu.esdihumboldt.hale.server.progress.impl.ProgressMonitor
All Implemented Interfaces:
Progress, org.eclipse.core.runtime.IProgressMonitor

public class ProgressMonitor
extends Object
implements org.eclipse.core.runtime.IProgressMonitor, Progress

Progress monitor that just stores the progress information.

Author:
Simon Templer

Field Summary
 
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor
UNKNOWN
 
Constructor Summary
ProgressMonitor()
           
 
Method Summary
 void beginTask(String name, int totalWork)
           
 void cancel()
          Cancel the job/task.
 void done()
           
 String getSubTask()
           
 String getTaskName()
           
 int getTotalWork()
           
 int getWorked()
           
 void internalWorked(double work)
           
 boolean isCanceled()
           
 boolean isIndeterminate()
           
 void setCanceled(boolean value)
           
 void setTaskName(String name)
           
 void subTask(String name)
           
 void worked(int work)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressMonitor

public ProgressMonitor()
Method Detail

beginTask

public void beginTask(String name,
                      int totalWork)
Specified by:
beginTask in interface org.eclipse.core.runtime.IProgressMonitor

done

public void done()
Specified by:
done in interface org.eclipse.core.runtime.IProgressMonitor

internalWorked

public void internalWorked(double work)
Specified by:
internalWorked in interface org.eclipse.core.runtime.IProgressMonitor

isCanceled

public boolean isCanceled()
Specified by:
isCanceled in interface Progress
Specified by:
isCanceled in interface org.eclipse.core.runtime.IProgressMonitor
Returns:
if the job/task is canceled

setCanceled

public void setCanceled(boolean value)
Specified by:
setCanceled in interface org.eclipse.core.runtime.IProgressMonitor

setTaskName

public void setTaskName(String name)
Specified by:
setTaskName in interface org.eclipse.core.runtime.IProgressMonitor

subTask

public void subTask(String name)
Specified by:
subTask in interface org.eclipse.core.runtime.IProgressMonitor

worked

public void worked(int work)
Specified by:
worked in interface org.eclipse.core.runtime.IProgressMonitor

getTaskName

public String getTaskName()
Specified by:
getTaskName in interface Progress
Returns:
the task name, may be null

getSubTask

public String getSubTask()
Specified by:
getSubTask in interface Progress
Returns:
the name of the current subtask, may be null

isIndeterminate

public boolean isIndeterminate()
Specified by:
isIndeterminate in interface Progress
Returns:
if the progress is indeterminate

getWorked

public int getWorked()
Specified by:
getWorked in interface Progress
Returns:
the already worked work units, should be ignored if Progress.isIndeterminate() is true

getTotalWork

public int getTotalWork()
Specified by:
getTotalWork in interface Progress
Returns:
the total work units, should be ignored if Progress.isIndeterminate() is true

cancel

public void cancel()
Description copied from interface: Progress
Cancel the job/task. Behavior on cancel depends on the implementation of job/task.

Specified by:
cancel in interface Progress

Humboldt Alignment Editor 2.5.0

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