Eclipse JDT
Release 3.0

Uses of Class
org.eclipse.ltk.core.refactoring.RefactoringStatus

Packages that use RefactoringStatus
org.eclipse.ltk.core.refactoring Application programmer interface to implement semantic preserving workspace transformations. 
org.eclipse.ltk.core.refactoring.participants Application programmer interface to participant in existing rename, move and delete refactorings if the refactoring provider supports participation. 
org.eclipse.ltk.ui.refactoring Application programmer interface to implement a wizard based user interface for refactorings. 
 

Uses of RefactoringStatus in org.eclipse.ltk.core.refactoring
 

Methods in org.eclipse.ltk.core.refactoring that return RefactoringStatus
 RefactoringStatus CreateChangeOperation.getConditionCheckingStatus()
          Returns the status of the condition checking.
 RefactoringStatus CheckConditionsOperation.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.
 RefactoringStatus Refactoring.checkAllConditions(IProgressMonitor pm)
          Checks all conditions.
abstract  RefactoringStatus Refactoring.checkInitialConditions(IProgressMonitor pm)
          Checks some initial conditions based on the element to be refactored.
abstract  RefactoringStatus Refactoring.checkFinalConditions(IProgressMonitor pm)
          After checkInitialConditions has been performed and the user has provided all input necessary to perform the refactoring this method is called to check the remaining preconditions.
 RefactoringStatus UndoTextFileChange.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform. If a refactoring status with a severity of FATAL is returned then the change has to be treated as invalid and can no longer be executed. Performing such a change produces an unspecified result and will very likely throw an exception.

This method is also called by the UndoManager to decide if an undo or redo change is still valid and therefore can be executed.

 RefactoringStatus CompositeChange.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform. If a refactoring status with a severity of FATAL is returned then the change has to be treated as invalid and can no longer be executed. Performing such a change produces an unspecified result and will very likely throw an exception.

This method is also called by the UndoManager to decide if an undo or redo change is still valid and therefore can be executed.

The composite change sends isValid to all its children until the first one returns a status with a severity of FATAL .
static RefactoringStatus RefactoringStatus.createStatus(int severity, String msg, RefactoringStatusContext context, String pluginId, int code, Object data)
          Creates a new RefactoringStatus with one entry filled with the given arguments.
static RefactoringStatus RefactoringStatus.createInfoStatus(String msg)
          Creates a new RefactorngStatus with one INFO entry filled with the given message.
static RefactoringStatus RefactoringStatus.createInfoStatus(String msg, RefactoringStatusContext context)
          Creates a new RefactorngStatus with one INFO entry filled with the given message and context.
static RefactoringStatus RefactoringStatus.createWarningStatus(String msg)
          Creates a new RefactorngStatus with one WARNING entry filled with the given message.
static RefactoringStatus RefactoringStatus.createWarningStatus(String msg, RefactoringStatusContext context)
          Creates a RefactorngStatus with one WARNING entry fill with the given message and context.
static RefactoringStatus RefactoringStatus.createErrorStatus(String msg)
          Creates a new RefactorngStatus with one ERROR entry filled with the given message.
static RefactoringStatus RefactoringStatus.createErrorStatus(String msg, RefactoringStatusContext context)
          Creates a RefactorngStatus with one ERROR entry fill with the given message and context.
static RefactoringStatus RefactoringStatus.createFatalErrorStatus(String msg)
          Creates a new RefactorngStatus with one FATAL entry filled with the given message.
static RefactoringStatus RefactoringStatus.createFatalErrorStatus(String msg, RefactoringStatusContext context)
          Creates a RefactorngStatus with one FATAL entry fill with the given message and context.
static RefactoringStatus RefactoringStatus.create(IStatus status)
          Creates a new RefactorngStatus from the given IStatus.
 RefactoringStatus DocumentChange.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform. If a refactoring status with a severity of FATAL is returned then the change has to be treated as invalid and can no longer be executed. Performing such a change produces an unspecified result and will very likely throw an exception.

This method is also called by the UndoManager to decide if an undo or redo change is still valid and therefore can be executed.

 RefactoringStatus PerformRefactoringOperation.getConditionStatus()
          Return the refactoring status of the condition checking.
 RefactoringStatus PerformRefactoringOperation.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.
 RefactoringStatus TextFileChange.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform. If a refactoring status with a severity of FATAL is returned then the change has to be treated as invalid and can no longer be executed. Performing such a change produces an unspecified result and will very likely throw an exception.

This method is also called by the UndoManager to decide if an undo or redo change is still valid and therefore can be executed.

 RefactoringStatus NullChange.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform. If a refactoring status with a severity of FATAL is returned then the change has to be treated as invalid and can no longer be executed. Performing such a change produces an unspecified result and will very likely throw an exception.

This method is also called by the UndoManager to decide if an undo or redo change is still valid and therefore can be executed.

 RefactoringStatus PerformChangeOperation.getConditionCheckingStatus()
          Returns the status of the condition checking.
 RefactoringStatus PerformChangeOperation.getValidationStatus()
          Returns the refactoring status returned from the call IChange#isValid().
abstract  RefactoringStatus Change.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform.
 

Methods in org.eclipse.ltk.core.refactoring with parameters of type RefactoringStatus
 boolean IValidationCheckResultQuery.proceed(RefactoringStatus status)
          Returns whether the undo proceeds or not.
 void IValidationCheckResultQuery.stopped(RefactoringStatus status)
          Called when the validation check returned a fatal error.
 void RefactoringStatus.merge(RefactoringStatus other)
          Merges the receiver and the parameter statuses.
 

Uses of RefactoringStatus in org.eclipse.ltk.core.refactoring.participants
 

Methods in org.eclipse.ltk.core.refactoring.participants that return RefactoringStatus
 RefactoringStatus CheckConditionsContext.check(IProgressMonitor pm)
          Checks the condition of all registered condition checkers and returns a merge status result.
 RefactoringStatus IConditionChecker.check(IProgressMonitor monitor)
          Performs the actual condition checking.
 RefactoringStatus ProcessorBasedRefactoring.checkInitialConditions(IProgressMonitor pm)
          Checks some initial conditions based on the element to be refactored. The method is typically called by the UI to perform an initial checks after an action has been executed.

The refactoring has to be considered as not being executable if the returned status has the severity of RefactoringStatus#FATAL.

This method can be called more than once.

 RefactoringStatus ProcessorBasedRefactoring.checkFinalConditions(IProgressMonitor pm)
          After checkInitialConditions has been performed and the user has provided all input necessary to perform the refactoring this method is called to check the remaining preconditions.

The refactoring has to be considered as not being executable if the returned status has the severity of RefactoringStatus#FATAL.

This method can be called more than once.

abstract  RefactoringStatus RefactoringProcessor.checkInitialConditions(IProgressMonitor pm)
          Checks some initial conditions based on the element to be refactored.
abstract  RefactoringStatus RefactoringProcessor.checkFinalConditions(IProgressMonitor pm, CheckConditionsContext context)
          Checks the final conditions based on the element to be refactored.
abstract  RefactoringStatus RefactoringParticipant.checkConditions(IProgressMonitor pm, CheckConditionsContext context)
          Checks the conditions of the refactoring participant.
 RefactoringStatus ValidateEditChecker.check(IProgressMonitor monitor)
          Performs the actual condition checking.
 

Methods in org.eclipse.ltk.core.refactoring.participants with parameters of type RefactoringStatus
static RenameParticipant[] ParticipantManager.loadRenameParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, RenameArguments arguments, String[] affectedNatures, SharableParticipants shared)
          Loads the rename participants for the given element.
static MoveParticipant[] ParticipantManager.loadMoveParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, MoveArguments arguments, String[] affectedNatures, SharableParticipants shared)
          Loads the move participants for the given element.
static DeleteParticipant[] ParticipantManager.loadDeleteParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, DeleteArguments arguments, String[] affectedNatures, SharableParticipants shared)
          Loads the delete participants for the given element.
static CreateParticipant[] ParticipantManager.loadCreateParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, CreateArguments arguments, String[] affectedNatures, SharableParticipants shared)
          Loads the create participants for the given element.
abstract  RefactoringParticipant[] RefactoringProcessor.loadParticipants(RefactoringStatus status, SharableParticipants sharedParticipants)
          Returns the array of participants.
 

Uses of RefactoringStatus in org.eclipse.ltk.ui.refactoring
 

Methods in org.eclipse.ltk.ui.refactoring that return RefactoringStatus
 RefactoringStatus RefactoringWizardOpenOperation.getInitialConditionCheckingStatus()
          Returns the outcome of the initial condition checking.
 

Methods in org.eclipse.ltk.ui.refactoring with parameters of type RefactoringStatus
 void UserInputWizardPage.setPageComplete(RefactoringStatus status)
          Sets the page's complete status depending on the given ReactoringStatus.
static Dialog RefactoringUI.createRefactoringStatusDialog(RefactoringStatus status, Shell parent, String windowTitle, boolean backButton)
          Creates a dialog to present a RefactoringStatus to the user.
 void RefactoringWizard.setInitialConditionCheckingStatus(RefactoringStatus status)
          Sets the initial condition checking status computed by the refactoring.
 


Eclipse JDT
Release 3.0

Copyright (c) IBM Corp. and others 2000, 2004. All Rights Reserved.