|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ltk.core.refactoring.PerformRefactoringOperation
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.
IWorkspace
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.
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
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public PerformRefactoringOperation(Refactoring refactoring, int style)
RefactoringStatus.FATAL
.
refactoring
- the refactoring to performstyle
- the condition checking style as defined by
CheckConditionsOperation
Method Detail |
public RefactoringStatus getConditionStatus()
null
if the operation hasn't been performed yetpublic RefactoringStatus getValidationStatus()
null
if a change couldn't be created or the operation
hasn't been performed yet.
public Change getUndoChange()
null
if no undo exists. The undo
object is initialize via the call Change.initializeValidationData(IProgressMonitor)
null
public void run(IProgressMonitor monitor) throws CoreException
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
.
run
in interface IWorkspaceRunnable
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this operation fails.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.