Eclipse Platform
2.0

org.eclipse.core.resources
Interface IWorkspaceRunnable


public interface IWorkspaceRunnable

A runnable which executes as a batch operation within the workspace. The IWorkspaceRunnable interface should be implemented by any class whose instances are intended to be run by IWorkspace.run.

Clients may implement this interface.

See Also:
IWorkspace.run(org.eclipse.core.resources.IWorkspaceRunnable, org.eclipse.core.runtime.IProgressMonitor)

Method Summary
 void run(IProgressMonitor monitor)
          Runs the operation reporting progress to and accepting cancellation requests from the given progress monitor.
 

Method Detail

run

public void run(IProgressMonitor monitor)
         throws CoreException
Runs the operation reporting progress to and accepting cancellation requests from the given progress monitor.

Implementors of this method should check the progress monitor for cancellation when it is safe and appropriate to do so. The cancellation request should be propagated to the caller by throwing OperationCanceledException.

Parameters:
monitor - a progress monitor, or null if progress reporting and cancellation are not desired
Throws:
CoreException - if this operation fails.

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.