EGF Engine
Release 0.1.0

org.eclipse.egf.common.progress
Class ProgressReporter

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

public class ProgressReporter
extends Object

A runner that executes runnable with progress reporting support.


Field Summary
static int TASK_DEFAULT_TICKS_COUNT
          An executed task default ticks count (in terms of reporting).
 
Constructor Summary
ProgressReporter()
           
 
Method Summary
static void asyncExec(IProgressRunnable runnable_p)
          Causes the IProgressRunnable.run(IProgressMonitor) method of the given runnable to be invoked by an eclipse job at the next reasonable opportunity.
static boolean syncExec(IProgressRunnable runnable_p, IProgressMonitor progressMonitor_p)
          Causes the IProgressRunnable.run(IProgressMonitor) method of the given runnable to be invoked by the calling thread.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TASK_DEFAULT_TICKS_COUNT

public static final int TASK_DEFAULT_TICKS_COUNT
An executed task default ticks count (in terms of reporting).

See Also:
Constant Field Values
Constructor Detail

ProgressReporter

public ProgressReporter()
Method Detail

asyncExec

public static void asyncExec(IProgressRunnable runnable_p)
Causes the IProgressRunnable.run(IProgressMonitor) method of the given runnable to be invoked by an eclipse job at the next reasonable opportunity. The caller continues to run in parallel, and is not notified when the runnable has completed.
The progress reporting is done through the progress monitor of the executing job (non-user one).

Parameters:
runnable_p -
See Also:
syncExec(IProgressRunnable, IProgressMonitor)

syncExec

public static boolean syncExec(IProgressRunnable runnable_p,
                               IProgressMonitor progressMonitor_p)
Causes the IProgressRunnable.run(IProgressMonitor) method of the given runnable to be invoked by the calling thread. This one is suspended until the runnable completes.
The progress reporting is done through the given progress monitor.

Parameters:
runnable_p -
progressMonitor_p - null to disable progress reporting.
See Also:
asyncExec(IProgressRunnable)

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.