org.eclipse.jface.operation.IRunnableWithProgress Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.operation;

import java.lang.reflect.InvocationTargetException;

import org.eclipse.core.runtime.IProgressMonitor;

/**
 * The IRunnableWithProgress 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.
 * 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.
 *
 * @see IRunnableContext
 */
public interface IRunnableWithProgress {
    /**
     * 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.
     *
     * @param monitor the progress monitor to use to display progress and receive
     *   requests for cancelation
     * @exception 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
     * @exception InterruptedException if the operation detects a request to cancel, 
     *  using IProgressMonitor.isCanceled(), it should exit by throwing 
     *  InterruptedException
     *
     * @see IRunnableContext#run
     */
    public void run(IProgressMonitor monitor) throws InvocationTargetException,
            InterruptedException;
}