Eclipse RSE Development Guide (Galileo) - IRSERunnableWithProgress (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core
Interface IRSERunnableWithProgress

public interface IRSERunnableWithProgress

The IRSERunnableWithProgress interface should be implemented by any class whose instances are intended to be executed as a long-running operation. Long-running operations are typically presented at the UI via a modal dialog showing a progress indicator and a Cancel button. This interface is derived from org.eclipse.jface.operation.IRunnableWithProgress, but brought into no-UI space. The class must define a run method that takes a progress monitor. The run method is usually not invoked directly, but rather by passing the IRunnableWithProgress to the run method of an IRunnableContext, which provides the UI for the progress monitor and Cancel button.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. Please do not use this API without consulting with the Target Management team.

Since:: org.eclipse.rse.core 3.0
See Also:: IRSEInteractionProvider

Method Summary

void run ( IProgressMonitor monitor)
Runs this operation.

Method Detail

run

void run(
IProgressMonitor monitor)
         throws 
InvocationTargetException,
                
InterruptedException

Runs this operation. Progress should be reported to the given progress monitor. This method is usually invoked by an IRunnableContext's run method, which supplies the progress monitor. A request to cancel the operation should be honored and acknowledged by throwing InterruptedException.

Parameters:: monitor - the progress monitor to use to display progress and receive requests for cancellation
Throws:: InvocationTargetException - if the run method must propagate a checked exception, it should wrap it inside an InvocationTargetException; runtime exceptions are automatically wrapped in an InvocationTargetException by the calling context; InterruptedException - if the operation detects a request to cancel, using IProgressMonitor.isCanceled(), it should exit by throwing InterruptedException
See Also:: IRSEInteractionProvider