org.eclipse.ltk.core.refactoring
Class PerformMultipleRefactoringsOperation

java.lang.Object
  org.eclipse.ltk.core.refactoring.PerformMultipleRefactoringsOperation

All Implemented Interfaces:

IWorkspaceRunnable

public class PerformMultipleRefactoringsOperation

extends Object

implements IWorkspaceRunnable

Operation that, when run, executes a series of refactoring sequentially. Refactorings are executed using PerformRefactoringOperation.

The operation should be executed via the run method offered by IWorkspace to achieve proper delta batching.

Note: this class is not intended to be extended outside of the refactoring framework.

Note: This API is considered experimental and may change in the near future.

Since:

3.2

See Also:

IWorkspace

Constructor Summary

PerformMultipleRefactoringsOperation(org.eclipse.ltk.core.refactoring.history.RefactoringHistory history)
Creates a new perform multiple refactorings operation.

Method Summary

RefactoringStatus	getExecutionStatus() Returns the execution status.
void	run(IProgressMonitor monitor) 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PerformMultipleRefactoringsOperation

public PerformMultipleRefactoringsOperation(org.eclipse.ltk.core.refactoring.history.RefactoringHistory history)

Creates a new perform multiple refactorings operation.

Parameters:

history - the refactoring history

Method Detail

getExecutionStatus

public RefactoringStatus getExecutionStatus()

Returns the execution status. Guaranteed not to be null.

Returns:

the status of the session

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.

Specified by:

run in interface IWorkspaceRunnable

Parameters:

monitor - a progress monitor, or null if progress reporting and cancellation are not desired

Throws:

CoreException - if this operation fails.