EGF Engine
Release 0.1.0

org.eclipse.egf.common.progress
Class ProductionProgressMonitor

java.lang.Object
  extended by org.eclipse.egf.common.progress.ProductionProgressMonitor

public class ProductionProgressMonitor
extends Object

Production progress monitor eases the usage of SubMonitor in patterns production or execution.
Have a look at SubMonitor, IProgressMonitor documentation.


Constructor Summary
ProductionProgressMonitor(SubMonitor parentMonitor_p, String taskName_p, int totalWork_p)
          Create a progress monitor for given parameters.
 
Method Summary
 void end()
          End this progress monitor.
 SubMonitor getMonitor()
          Return the underlying monitor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProductionProgressMonitor

public ProductionProgressMonitor(SubMonitor parentMonitor_p,
                                 String taskName_p,
                                 int totalWork_p)
Create a progress monitor for given parameters.

Parameters:
parentMonitor_p - the parent monitor for this progress monitor.
taskName_p - the end-user task name displayed in progress reporter.
totalWork_p - number of ticks to allocate
Method Detail

getMonitor

public SubMonitor getMonitor()
Return the underlying monitor.

Returns:
the monitor

end

public void end()
End this progress monitor.


EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.