org.eclipse.net4j.util.om.monitor
Class EclipseMonitor

java.lang.Object
  extended by org.eclipse.net4j.util.om.monitor.AbstractMonitor
      extended by org.eclipse.net4j.util.om.monitor.Monitor
          extended by org.eclipse.net4j.util.om.monitor.EclipseMonitor
All Implemented Interfaces:
OMMonitor, OMMonitorProgress

public class EclipseMonitor
extends Monitor

Since:
2.0

Nested Class Summary
static class EclipseMonitor.SynchronizedSubProgressMonitor
          A sub progress monitor that synchronizes all methods on the parent monitor instance.
 
Nested classes/interfaces inherited from class org.eclipse.net4j.util.om.monitor.AbstractMonitor
AbstractMonitor.AsyncTimerTask
 
Nested classes/interfaces inherited from interface org.eclipse.net4j.util.om.monitor.OMMonitor
OMMonitor.Async
 
Field Summary
 
Fields inherited from class org.eclipse.net4j.util.om.monitor.Monitor
DEFAULT_ASYNC_SCHEDULE_PERIOD
 
Fields inherited from interface org.eclipse.net4j.util.om.monitor.OMMonitor
DEFAULT_TIME_FACTOR, THOUSAND
 
Fields inherited from interface org.eclipse.net4j.util.om.monitor.OMMonitorProgress
HUNDRED, ONE, TEN, ZERO
 
Constructor Summary
EclipseMonitor(IProgressMonitor progressMonitor)
           
EclipseMonitor(IProgressMonitor progressMonitor, String taskName)
           
 
Method Summary
 OMMonitor begin(double totalWork)
           
 void done()
           
 String getTaskName()
           
 boolean isCanceled()
           
 void worked(double work)
           
 
Methods inherited from class org.eclipse.net4j.util.om.monitor.Monitor
cancel, cancel, checkCanceled, getAsyncSchedulePeriod, getTimer, scheduleAtFixedRate
 
Methods inherited from class org.eclipse.net4j.util.om.monitor.AbstractMonitor
begin, createAsyncTimerTask, createNestedMonitor, fork, fork, forkAsync, forkAsync, getTotalWork, getWork, getWorkPercent, hasBegun, percent, worked
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EclipseMonitor

public EclipseMonitor(IProgressMonitor progressMonitor,
                      String taskName)

EclipseMonitor

public EclipseMonitor(IProgressMonitor progressMonitor)
Method Detail

getTaskName

public String getTaskName()

isCanceled

public boolean isCanceled()
Specified by:
isCanceled in interface OMMonitor
Overrides:
isCanceled in class Monitor

begin

public OMMonitor begin(double totalWork)
                throws MonitorCanceledException
Specified by:
begin in interface OMMonitor
Overrides:
begin in class AbstractMonitor
Throws:
MonitorCanceledException

worked

public void worked(double work)
            throws MonitorCanceledException
Specified by:
worked in interface OMMonitor
Overrides:
worked in class AbstractMonitor
Throws:
MonitorCanceledException

done

public void done()
Specified by:
done in interface OMMonitor
Overrides:
done in class AbstractMonitor


Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) and others.