/*******************************************************************************
* Copyright (c) 2000, 2009 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.core.runtime;
/**
* Safe runnables represent blocks of code and associated exception
* handlers. They are typically used when a plug-in needs to call some
* untrusted code (e.g., code contributed by another plug-in via an
* extension).
* <p>
* This interface can be used without OSGi running.
* </p><p>
* Clients may implement this interface.
* </p>
* @see SafeRunner#run(ISafeRunnable)
*/
public interface ISafeRunnable {
/**
* Handles an exception thrown by this runnable's <code>run</code>
* method. The processing done here should be specific to the
* particular usecase for this runnable. Generalized exception
* processing (e.g., logging in the platform's log) is done by the
* {@link SafeRunner}.
* <p>
* All exceptions from the {@link #run} method are passed to this method,
* along with certain {@link Error} types that are typically caused by
* programming errors in the untrusted code being run.
* </p>
*
* @param exception an exception which occurred during processing
* the body of this runnable (i.e., in <code>run()</code>)
* @see SafeRunner#run(ISafeRunnable)
*/
public void handleException(Throwable exception);
/**
* Runs this runnable. Any exceptions thrown from this method will
* be passed to this runnable's <code>handleException</code>
* method.
*
* @exception Exception if a problem occurred while running this method.
* The exception will be processed by <code>handleException</code>
* @see SafeRunner#run(ISafeRunnable)
*/
public void run() throws Exception;
}