Eclipse Platform
Release 3.4

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 programming interface to participant in existing rename, move and delete refactorings if the refactoring provider supports participation. 
org.eclipse.ltk.core.refactoring.resource Application programmer interface to implement resource dependend refactorings. 
org.eclipse.ltk.ui.refactoring Application programming interface to implement a wizard based user interface for refactorings. 
org.eclipse.ltk.ui.refactoring.history Application programming interface to display and preview refactoring history information. 
 

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

Methods in org.eclipse.ltk.core.refactoring that return RefactoringStatus
 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 PerformChangeOperation.getConditionCheckingStatus()
          Returns the status of the condition checking.
 RefactoringStatus PerformChangeOperation.getValidationStatus()
          Returns the refactoring status returned from the call IChange#isValid().
 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.
abstract  RefactoringStatus Change.isValid(IProgressMonitor pm)
          Verifies that this change object is still valid and can be executed by calling perform.
 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 CreateChangeOperation.getConditionCheckingStatus()
          Returns the status of the condition checking.
 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 TextFileChange.isValid(IProgressMonitor monitor)
          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.

protected  RefactoringStatus PerformRefactoringHistoryOperation.aboutToPerformRefactoring(Refactoring refactoring, RefactoringDescriptor descriptor, IProgressMonitor monitor)
          Hook method which is called when the specified refactoring is going to be executed.
 RefactoringStatus PerformRefactoringHistoryOperation.getExecutionStatus()
          Returns the execution status.
 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 MultiStateTextFileChange.isValid(IProgressMonitor monitor)
           
 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 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 RefactoringStatus with one INFO entry filled with the given message.
static RefactoringStatus RefactoringStatus.createInfoStatus(String msg, RefactoringStatusContext context)
          Creates a new RefactoringStatus with one INFO entry filled with the given message and context.
static RefactoringStatus RefactoringStatus.createWarningStatus(String msg)
          Creates a new RefactoringStatus with one WARNING entry filled with the given message.
static RefactoringStatus RefactoringStatus.createWarningStatus(String msg, RefactoringStatusContext context)
          Creates a RefactoringStatus with one WARNING entry fill with the given message and context.
static RefactoringStatus RefactoringStatus.createErrorStatus(String msg)
          Creates a new RefactoringStatus with one ERROR entry filled with the given message.
static RefactoringStatus RefactoringStatus.createErrorStatus(String msg, RefactoringStatusContext context)
          Creates a RefactoringStatus with one ERROR entry fill with the given message and context.
static RefactoringStatus RefactoringStatus.createFatalErrorStatus(String msg)
          Creates a new RefactoringStatus with one FATAL entry filled with the given message.
static RefactoringStatus RefactoringStatus.createFatalErrorStatus(String msg, RefactoringStatusContext context)
          Creates a RefactoringStatus with one FATAL entry fill with the given message and context.
static RefactoringStatus RefactoringStatus.create(IStatus status)
          Creates a new RefactoringStatus from the given IStatus.
 

Methods in org.eclipse.ltk.core.refactoring with parameters of type RefactoringStatus
abstract  Refactoring RefactoringDescriptor.createRefactoring(RefactoringStatus status)
          Creates the a new refactoring instance for this refactoring descriptor.
 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.
protected  Refactoring PerformRefactoringHistoryOperation.createRefactoring(RefactoringDescriptor descriptor, RefactoringStatus status)
          Deprecated. since 3.4. Override PerformRefactoringHistoryOperation.createRefactoring(RefactoringDescriptor, RefactoringStatus, IProgressMonitor) instead
protected  Refactoring PerformRefactoringHistoryOperation.createRefactoring(RefactoringDescriptor descriptor, RefactoringStatus status, IProgressMonitor monitor)
          Method which is called to create a refactoring instance from a refactoring descriptor.
 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 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.

 RefactoringStatus ValidateEditChecker.check(IProgressMonitor monitor)
          Performs the actual condition checking.
 RefactoringStatus IConditionChecker.check(IProgressMonitor monitor)
          Performs the actual condition checking.
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.
 RefactoringStatus CheckConditionsContext.check(IProgressMonitor pm)
          Checks the condition of all registered condition checkers and returns a merge status result.
abstract  RefactoringStatus RefactoringParticipant.checkConditions(IProgressMonitor pm, CheckConditionsContext context)
          Checks the conditions of the refactoring participant.
static RefactoringStatus ResourceChangeChecker.checkFilesToBeChanged(IFile[] files, IProgressMonitor monitor)
          A helper method to check a set of changed files.
 RefactoringStatus ResourceChangeChecker.check(IProgressMonitor monitor)
           
 

Methods in org.eclipse.ltk.core.refactoring.participants with parameters of type RefactoringStatus
 RefactoringParticipant[] ParticipantExtensionPoint.getParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, RefactoringArguments arguments, IParticipantDescriptorFilter filter, String[] affectedNatures, SharableParticipants shared)
          Returns all participants for a given element.
abstract  RefactoringParticipant[] RefactoringProcessor.loadParticipants(RefactoringStatus status, SharableParticipants sharedParticipants)
          Returns the array of participants.
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 RenameParticipant[] ParticipantManager.loadRenameParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, RenameArguments arguments, IParticipantDescriptorFilter filter, 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 MoveParticipant[] ParticipantManager.loadMoveParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, MoveArguments arguments, IParticipantDescriptorFilter filter, 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 DeleteParticipant[] ParticipantManager.loadDeleteParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, DeleteArguments arguments, IParticipantDescriptorFilter filter, 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.
static CreateParticipant[] ParticipantManager.loadCreateParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, CreateArguments arguments, IParticipantDescriptorFilter filter, String[] affectedNatures, SharableParticipants shared)
          Loads the create participants for the given element.
static CopyParticipant[] ParticipantManager.loadCopyParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, CopyArguments arguments, String[] affectedNatures, SharableParticipants shared)
          Loads the copy participants for the given element.
static CopyParticipant[] ParticipantManager.loadCopyParticipants(RefactoringStatus status, RefactoringProcessor processor, Object element, CopyArguments arguments, IParticipantDescriptorFilter filter, String[] affectedNatures, SharableParticipants shared)
          Loads the copy participants for the given element.
 boolean IParticipantDescriptorFilter.select(IConfigurationElement element, RefactoringStatus status)
          Returns whether the given element makes it through this filter.
 

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

Methods in org.eclipse.ltk.core.refactoring.resource that return RefactoringStatus
 RefactoringStatus ResourceChange.isValid(IProgressMonitor pm)
          This implementation of Change.isValid(IProgressMonitor) tests the modified resource using the validation method specified by ResourceChange.setValidationMethod(int).
 

Methods in org.eclipse.ltk.core.refactoring.resource with parameters of type RefactoringStatus
 Refactoring MoveResourcesDescriptor.createRefactoring(RefactoringStatus status)
           
 Refactoring RenameResourceDescriptor.createRefactoring(RefactoringStatus status)
           
 Refactoring DeleteResourcesDescriptor.createRefactoring(RefactoringStatus status)
           
protected static void ResourceChange.checkIfModifiable(RefactoringStatus result, IResource resource, int validationMethod)
          Utility method to validate a resource to be modified.
 

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
static Dialog RefactoringUI.createLightWeightStatusDialog(RefactoringStatus status, Shell parent, String windowTitle)
          Creates a light-weight dialog to present a RefactoringStatus to the user.
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.
 void UserInputWizardPage.setPageComplete(RefactoringStatus status)
          Sets the page's complete status depending on the given ReactoringStatus.
 

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

Methods in org.eclipse.ltk.ui.refactoring.history that return RefactoringStatus
protected  RefactoringStatus RefactoringHistoryWizard.aboutToPerformHistory(IProgressMonitor monitor)
          Hook method which is called before the first refactoring of the history is executed.
protected  RefactoringStatus RefactoringHistoryWizard.aboutToPerformRefactoring(Refactoring refactoring, RefactoringDescriptor descriptor, IProgressMonitor monitor)
          Hook method which is called before the a refactoring of the history is executed.
protected  RefactoringStatus RefactoringHistoryWizard.historyPerformed(IProgressMonitor monitor)
          Hook method which is called when all refactorings of the history have been executed.
 RefactoringStatus RefactoringHistoryWizard.performPreviewChange(Change change, Refactoring refactoring)
          Performs the change previously displayed in the preview.
protected  RefactoringStatus RefactoringHistoryWizard.refactoringPerformed(Refactoring refactoring, IProgressMonitor monitor)
          Hook method which is called when the specified refactoring has been performed, e.g. its change object has been successfully applied to the workspace.
 

Methods in org.eclipse.ltk.ui.refactoring.history with parameters of type RefactoringStatus
protected  Refactoring RefactoringHistoryWizard.createRefactoring(RefactoringDescriptor descriptor, RefactoringStatus status)
          Method which is called to create a refactoring instance from a refactoring descriptor.
protected  Refactoring RefactoringHistoryWizard.createRefactoring(RefactoringDescriptor descriptor, RefactoringStatus status, IProgressMonitor monitor)
          Creates a refactoring from the specified refactoring descriptor.
 


Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.