Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.ltk.core.refactoring
Class CreateChangeOperation  view CreateChangeOperation download CreateChangeOperation.java

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.CreateChangeOperation
All Implemented Interfaces:
org.eclipse.core.resources.IWorkspaceRunnable

public class CreateChangeOperation
extends java.lang.Object
implements org.eclipse.core.resources.IWorkspaceRunnable

Operation that, when performed, creates a Change object for a given refactoring. If created with a refactoring object directly, no precondition checking is performed. If created with a CheckConditionsOperation the requested precondition checking is performed before creating the change.

If the precondition checking returns a fatal error or the status's severity exceeds a certain threshold then no change will be created.

If a change has been created the operation calls Change.initializeValidationData(IProgressMonitor) 55 to initialize the change's validation data.

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

Field Summary
private  Change fChange
           
private  CheckConditionsOperation fCheckConditionOperation
           
private  int fConditionCheckingFailedSeverity
           
private  Refactoring fRefactoring
           
 
Constructor Summary
CreateChangeOperation(CheckConditionsOperation operation, int checkFailedSeverity)
          Creates a new operation with the given CheckConditionsOperation.
CreateChangeOperation(Refactoring refactoring)
          Creates a new operation with the given refactoring.
 
Method Summary
 Change getChange()
          Returns the outcome of the operation or null if an exception occurred when performing the operation or the operation hasn't been performed yet.
 int getConditionCheckingFailedSeverity()
          Returns the condition checking failed severity used by this operation.
 RefactoringStatus getConditionCheckingStatus()
          Returns the status of the condition checking.
 int getConditionCheckingStyle()
          Returns the condition checking style as set to the CheckConditionsOperation.
 void run(org.eclipse.core.runtime.IProgressMonitor pm)
          null
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fRefactoring

private Refactoring fRefactoring

fCheckConditionOperation

private CheckConditionsOperation fCheckConditionOperation

fConditionCheckingFailedSeverity

private int fConditionCheckingFailedSeverity

fChange

private Change fChange
Constructor Detail

CreateChangeOperation

public CreateChangeOperation(Refactoring refactoring)
Creates a new operation with the given refactoring. No condition checking is performed before creating the change object. It is assumed that the condition checking has already been performed outside of this operation. The operation might fail if the precondition checking has not been performed yet.


CreateChangeOperation

public CreateChangeOperation(CheckConditionsOperation operation,
                             int checkFailedSeverity)
Creates a new operation with the given CheckConditionsOperation. When performed the operation first checks the conditions as specified by the CheckConditionsOperation. Depending on the result of the condition checking a change object is created or not.

Method Detail

getConditionCheckingFailedSeverity

public int getConditionCheckingFailedSeverity()
Returns the condition checking failed severity used by this operation.


run

public void run(org.eclipse.core.runtime.IProgressMonitor pm)
         throws org.eclipse.core.runtime.CoreException
null

Specified by:
run in interface org.eclipse.core.resources.IWorkspaceRunnable

getChange

public Change getChange()
Returns the outcome of the operation or null if an exception occurred when performing the operation or the operation hasn't been performed yet.


getConditionCheckingStatus

public RefactoringStatus getConditionCheckingStatus()
Returns the status of the condition checking. Returns null if no condition checking has been requested.


getConditionCheckingStyle

public int getConditionCheckingStyle()
Returns the condition checking style as set to the CheckConditionsOperation. If no condition checking operation is provided (e.g. the change is created directly by calling Refactoring.createChange(IProgressMonitor) 55 then CheckConditionsOperation.NONE 55 is returned.