Class DeleteResourceChange
- java.lang.Object
-
- org.eclipse.ltk.core.refactoring.Change
-
- org.eclipse.ltk.core.refactoring.resource.ResourceChange
-
- org.eclipse.ltk.core.refactoring.resource.DeleteResourceChange
-
- All Implemented Interfaces:
IAdaptable
public class DeleteResourceChange extends ResourceChange
Changethat deletes a resource.- Since:
- 3.4
-
-
Field Summary
-
Fields inherited from class org.eclipse.ltk.core.refactoring.resource.ResourceChange
SAVE_IF_DIRTY, VALIDATE_DEFAULT, VALIDATE_NOT_DIRTY, VALIDATE_NOT_READ_ONLY
-
-
Constructor Summary
Constructors Constructor Description DeleteResourceChange(IPath resourcePath, boolean forceOutOfSync)Delete a resource.DeleteResourceChange(IPath resourcePath, boolean forceOutOfSync, boolean deleteContent)Delete a resource.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChangeDescriptorgetDescriptor()Returns a descriptor of this change.protected IResourcegetModifiedResource()Returns the resource of this change.StringgetName()Returns the human readable name of this change.Changeperform(IProgressMonitor pm)Performs this change.voidsetDescriptor(ChangeDescriptor descriptor)Sets the change descriptor to be returned byChange.getDescriptor().-
Methods inherited from class org.eclipse.ltk.core.refactoring.resource.ResourceChange
checkIfModifiable, getModifiedElement, initializeValidationData, isValid, setValidationMethod, toString
-
Methods inherited from class org.eclipse.ltk.core.refactoring.Change
dispose, getAdapter, getAffectedObjects, getParent, isEnabled, setEnabled, setEnabledShallow
-
-
-
-
Constructor Detail
-
DeleteResourceChange
public DeleteResourceChange(IPath resourcePath, boolean forceOutOfSync)
Delete a resource.- Parameters:
resourcePath- the resource pathforceOutOfSync- iftrue, deletes the resource withIResource.FORCE
-
DeleteResourceChange
public DeleteResourceChange(IPath resourcePath, boolean forceOutOfSync, boolean deleteContent)
Delete a resource.- Parameters:
resourcePath- the project pathforceOutOfSync- iftrue, deletes the resource withIResource.FORCEdeleteContent- iftruedelete the project contents. The content delete is not undoable. This setting only applies to projects and is not used when deleting files or folders.
-
-
Method Detail
-
getModifiedResource
protected IResource getModifiedResource()
Description copied from class:ResourceChangeReturns the resource of this change.- Specified by:
getModifiedResourcein classResourceChange- Returns:
- the resource of this change
-
getName
public String getName()
Description copied from class:ChangeReturns the human readable name of this change. The name MUST not benull.
-
perform
public Change perform(IProgressMonitor pm) throws CoreException
Description copied from class:ChangePerforms this change. If this method is called on an invalid or disabled change object the result is unspecified. Changes should in general not respond toIProgressMonitor.isCanceled()since canceling a change tree in the middle of its execution leaves the workspace in a half changed state.- Specified by:
performin classChange- Parameters:
pm- a progress monitor- Returns:
- the undo change for this change object or
nullif no undo is provided - Throws:
CoreException- if an error occurred during change execution
-
getDescriptor
public ChangeDescriptor getDescriptor()
Description copied from class:ChangeReturns a descriptor of this change.Subclasses of changes created by
Refactoring.createChange(IProgressMonitor)should override this method to return aRefactoringChangeDescriptor. A change tree created by a particular refactoring is supposed to contain at most one change which returns a refactoring descriptor. Refactorings usually return an instance ofCompositeChangein theirRefactoring.createChange(IProgressMonitor)method which implements this method. The refactoring framework searches the change tree top-down until a refactoring descriptor is found.- Overrides:
getDescriptorin classChange- Returns:
- a descriptor of this change, or
nullif this change does not provide a change descriptor.
-
setDescriptor
public void setDescriptor(ChangeDescriptor descriptor)
Sets the change descriptor to be returned byChange.getDescriptor().- Parameters:
descriptor- the change descriptor
-
-