Eclipse Plug-in Developer Guide (Galileo) - PerformRefactoringOperation (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ltk.core.refactoring
Class PerformRefactoringOperation


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

All Implemented Interfaces:: IWorkspaceRunnable

public class PerformRefactoringOperation
extends Object
implements IWorkspaceRunnable
extends Object
implements IWorkspaceRunnable

Operation that, when run, executes a refactoring. This includes condition checking, change creation, change execution and remembering of the undo change on the refactoring's undo stack.

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 by clients.

Since:: 3.0
See Also:: IWorkspace
Restriction:: This class is not intended to be subclassed by clients.

Constructor Summary

PerformRefactoringOperation ( Refactoring refactoring, int style)
          Create a new perform refactoring operation.

Method Summary

RefactoringStatus getConditionStatus ()
          Return the refactoring status of the condition checking.

Change getUndoChange ()
          The undo object or null if no undo exists.

RefactoringStatus getValidationStatus ()
          Returns the refactoring status of the change's validation checking or null if a change couldn't be created or the operation hasn't been performed yet.

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

Methods inherited from class java.lang. Object

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

Constructor Detail

PerformRefactoringOperation

public PerformRefactoringOperation(
Refactoring refactoring,
                                   int style)

Create a new perform refactoring operation. The operation will not perform the refactoring if the refactoring's condition checking returns an error of severity RefactoringStatus.FATAL.

Parameters:: refactoring - the refactoring to perform; style - the condition checking style as defined by CheckConditionsOperation

Method Detail

getConditionStatus

public 
RefactoringStatus getConditionStatus()

Return the refactoring status of the condition checking.

Returns:: the refactoring status of the condition checking or null if the operation hasn't been performed yet

getValidationStatus

public 
RefactoringStatus getValidationStatus()

Returns the refactoring status of the change's validation checking or null if a change couldn't be created or the operation hasn't been performed yet.

Returns:: the refactoring status of the change's validation checking

getUndoChange

public 
Change getUndoChange()

The undo object or null if no undo exists. The undo object is initialize via the call Change.initializeValidationData(IProgressMonitor)

Returns:: the undo object or null

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.