Eclipse Platform
Release 3.4

org.eclipse.ltk.core.refactoring.resource
Class MoveResourceChange

java.lang.Object
  extended byorg.eclipse.ltk.core.refactoring.Change
      extended byorg.eclipse.ltk.core.refactoring.resource.ResourceChange
          extended byorg.eclipse.ltk.core.refactoring.resource.MoveResourceChange
All Implemented Interfaces:
IAdaptable

public class MoveResourceChange
extends ResourceChange

Change that moves 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
  MoveResourceChange(IResource source, IContainer target)
          Creates the change.
protected MoveResourceChange(IResource source, IContainer target, long stampToRestore, Change restoreSourceChange)
          Creates the change.
 
Method Summary
 ChangeDescriptor getDescriptor()
          Returns a descriptor of this change.
protected  IResource getModifiedResource()
          Returns the resource of this change.
 String getName()
          Returns the human readable name of this change.
 Change perform(IProgressMonitor monitor)
          Performs this change.
 void setDescriptor(ChangeDescriptor descriptor)
          Sets the change descriptor to be returned by Change.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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MoveResourceChange

public MoveResourceChange(IResource source,
                          IContainer target)
Creates the change.

Parameters:
source - the resource to move
target - the container the resource is moved to. An existing resource at the destination will be replaced.

MoveResourceChange

protected MoveResourceChange(IResource source,
                             IContainer target,
                             long stampToRestore,
                             Change restoreSourceChange)
Creates the change.

Parameters:
source - the resource to move
target - the container the resource is moved to. An existing resource at the destination will be replaced.
stampToRestore - the stamp to restore on the moved resource
restoreSourceChange - the change to restore a resource at the source or null if no resource needs to be resourced.
Method Detail

getDescriptor

public ChangeDescriptor getDescriptor()
Description copied from class: Change
Returns a descriptor of this change.

Subclasses of changes created by Refactoring.createChange(IProgressMonitor) should override this method to return a RefactoringChangeDescriptor. 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 of CompositeChange in their Refactoring.createChange(IProgressMonitor) method which implements this method. The refactoring framework searches the change tree top-down until a refactoring descriptor is found.

Overrides:
getDescriptor in class Change
Returns:
a descriptor of this change, or null if this change does not provide a change descriptor.

setDescriptor

public void setDescriptor(ChangeDescriptor descriptor)
Sets the change descriptor to be returned by Change.getDescriptor().

Parameters:
descriptor - the change descriptor

perform

public final Change perform(IProgressMonitor monitor)
                     throws CoreException,
                            OperationCanceledException
Description copied from class: Change
Performs this change. If this method is call on an invalid or disabled change object the result is unspecified. Changes should in general not respond to IProgressMonitor.isCanceled() since canceling a change tree in the middle of its execution leaves the workspace in a half changed state.

Specified by:
perform in class Change
Parameters:
monitor - a progress monitor
Returns:
the undo change for this change object or null if no undo is provided
Throws:
CoreException - if an error occurred during change execution
OperationCanceledException

getModifiedResource

protected IResource getModifiedResource()
Description copied from class: ResourceChange
Returns the resource of this change.

Specified by:
getModifiedResource in class ResourceChange
Returns:
the resource of this change

getName

public String getName()
Description copied from class: Change
Returns the human readable name of this change. The name MUST not be null.

Specified by:
getName in class Change
Returns:
the human readable name of this change

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

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