|
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.CheckConditionsOperation
Operation that, when run, checks the preconditions of the Refactoring
passed on creation.
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.
Refactoring.checkInitialConditions(IProgressMonitor)
,
Refactoring.checkFinalConditions(IProgressMonitor)
,
Refactoring.checkAllConditions(IProgressMonitor)
Field Summary | |
---|---|
static int |
ALL_CONDITIONS
Flag indicating that all conditions will be checked |
static int |
FINAL_CONDITIONS
Flag indicating that only final conditions will be checked |
static int |
INITIAL_CONDITONS
Flag indicating that only initial conditions will be checked |
static int |
NONE
Flag indicating that no conditions will be checked |
Constructor Summary | |
---|---|
CheckConditionsOperation(Refactoring refactoring,
int style)
Creates a new CheckConditionsOperation . |
Method Summary | |
---|---|
Refactoring |
getRefactoring()
Returns the operation's refactoring |
RefactoringStatus |
getStatus()
Returns the outcome of the operation or null if an exception
has occurred while performing the operation or if the operation hasn't
been performed yet. |
int |
getStyle()
Returns the condition checking style. |
void |
run(IProgressMonitor pm)
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 |
Field Detail |
public static final int NONE
public static final int INITIAL_CONDITONS
public static final int FINAL_CONDITIONS
public static final int ALL_CONDITIONS
Constructor Detail |
public CheckConditionsOperation(Refactoring refactoring, int style)
CheckConditionsOperation
.
refactoring
- the refactoring for which the preconditions are to
be checked.style
- style to define which conditions to check. Must be one of
INITIAL_CONDITONS
, FINAL_CONDITIONS
or
ALL_CONDITIONS
Method Detail |
public void run(IProgressMonitor pm) 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
pm
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if this operation fails.public RefactoringStatus getStatus()
null
if an exception
has occurred while performing the operation or if the operation hasn't
been performed yet.
RefactoringStatus
of the condition checkingpublic Refactoring getRefactoring()
public int getStyle()
|
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.