blob: 69916b0d2519e2752634655f6144753b751ee23d [file] [log] [blame]
package org.eclipse.team.ccvs.core;
/*
* (c) Copyright IBM Corp. 2001, 2002.
* All Rights Reserved.
*/
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.team.internal.ccvs.core.CVSException;
/**
* A runnable which executes as a batch operation within a specific cvs local
* workspace.
* The <code>ICVSRunnable</code> interface should be implemented by any class whose
* instances are intended to be run by <code>IWorkspace.run</code>.
* <p>
* Clients may implement this interface.
* </p>
* @see
*/
public interface ICVSRunnable {
/**
* Runs the operation reporting progress to and accepting
* cancellation requests from the given progress monitor.
* <p>
* 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
* <code>OperationCanceledException</code>.
* </p>
*
* @param monitor a progress monitor, or <code>null</code> if progress
* reporting and cancellation are not desired
* @exception CoreException if this operation fails.
*/
public void run(IProgressMonitor monitor) throws CVSException;
}