|
 |
|
| |
org.eclipse.core.resources.team
Interface IMoveDeleteHook
-
public interface IMoveDeleteHook
Primary interface for hooking the implementation of
IResource.move and IResource.delete.
This interface is intended to be implemented by the team component in
conjunction with the org.eclipse.core.resources.moveDeleteHook
standard extension point. Individual team providers may also implement this
interface. It is not intended to be implemented by other clients. The methods
defined on this interface are called from within the implementations of
IResource.move and IResource.delete. They are not
intended to be called from anywhere else.
-
Since:
- 2.0
|
Method Summary
|
boolean
|
deleteFile
(
IResourceTree tree,
IFile file,
int updateFlags,
IProgressMonitor monitor)
Implements IResource.delete(int,IProgressMonitor) where the
receiver is a file. |
boolean
|
deleteFolder
(
IResourceTree tree,
IFolder folder,
int updateFlags,
IProgressMonitor monitor)
Implements IResource.delete(int,IProgressMonitor) where the
receiver is a folder. |
boolean
|
deleteProject
(
IResourceTree tree,
IProject project,
int updateFlags,
IProgressMonitor monitor)
Implements IResource.delete(int,IProgressMonitor) where the
receiver is a project. |
boolean
|
moveFile
(
IResourceTree tree,
IFile source,
IFile destination,
int updateFlags,
IProgressMonitor monitor)
Implements IResource.move(IPath,int,IProgressMonitor) where
the receiver is a file. |
boolean
|
moveFolder
(
IResourceTree tree,
IFolder source,
IFolder destination,
int updateFlags,
IProgressMonitor monitor)
Implements IResource.move(IPath,int,IProgressMonitor) where
the receiver is a project. |
boolean
|
moveProject
(
IResourceTree tree,
IProject source,
IProjectDescription description,
int updateFlags,
IProgressMonitor monitor)
Implements IResource.move(IPath,int,IProgressMonitor) and
IResource.move(IProjectDescription,int,IProgressMonitor)
where the receiver is a project. |
deleteFile
boolean deleteFile(
IResourceTree tree,
IFile file,
int updateFlags,
IProgressMonitor monitor)
- Implements
IResource.delete(int,IProgressMonitor) where the
receiver is a file. Returns true to accept responsibility
for implementing this operation as per the API contract.
In broad terms, a full re-implementation should delete the file in the
local file system and then call tree.deletedFile to complete
the updating of the workspace resource tree to reflect this fact. If
unsuccessful in deleting the file from the local file system, it
should instead call tree.failed to report the reason for
the failure. In either case, it should return true to
indicate that the operation was attempted. The FORCE update
flag needs to be honored: unless FORCE is specified, the
implementation must use tree.isSynchronized to determine
whether the file is in sync before attempting to delete it.
The KEEP_HISTORY update flag needs to be honored as well;
use tree.addToLocalHistory to capture the contents of the
file before deleting it from the local file system.
An extending implementation should perform whatever pre-processing it
needs to do and then call tree.standardDeleteFile to
explicitly invoke the standard file deletion behavior, which deletes
both the file from the local file system and updates the workspace
resource tree. It should return true to indicate that the
operation was attempted.
Returning false is the easy way for the implementation to
say "pass". It is equivalent to calling
tree.standardDeleteFile and returning true.
The implementation of this method runs "below" the resources API and is
therefore very restricted in what resource API method it can call. The
list of useable methods includes most resource operations that read but
do not update the resource tree; resource operations that modify
resources and trigger deltas must not be called from within the dynamic
scope of the invocation of this method.
-
-
Parameters:
-
tree - the workspace resource tree; this object is only valid
for the duration of the invocation of this method, and must not be
used after this method has completed -
file - the handle of the file to delete; the receiver of
IResource.delete(int,IProgressMonitor)
-
updateFlags - bit-wise or of update flag constants as per
IResource.delete(int,IProgressMonitor)
-
monitor - the progress monitor, or null as per
IResource.delete(int,IProgressMonitor)
-
Returns:
-
false if this method declined to assume
responsibility for this operation, and true if this method
attempted to carry out the operation
-
Throws:
-
OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided. -
See Also:
-
IResource.delete(int,IProgressMonitor)
deleteFolder
boolean deleteFolder(
IResourceTree tree,
IFolder folder,
int updateFlags,
IProgressMonitor monitor)
- Implements
IResource.delete(int,IProgressMonitor) where the
receiver is a folder. Returns true to accept responsibility
for implementing this operation as per the API contract.
In broad terms, a full re-implementation should delete the directory tree
in the local file system and then call tree.deletedFolder to
complete the updating of the workspace resource tree to reflect this fact.
If unsuccessful in deleting the directory or any of its descendents from
the local file system, it should instead call tree.failed to
report each reason for failure. In either case it should return
true to indicate that the operation was attempted.
The FORCE update flag needs to be honored: unless
FORCE is specified, the implementation must use
tree.isSynchronized to determine whether the folder
subtree is in sync before attempting to delete it.
The KEEP_HISTORY update flag needs to be honored as well;
use tree.addToLocalHistory to capture the contents of any
files being deleted.
A partial re-implementation should perform whatever pre-processing it
needs to do and then call tree.standardDeleteFolder to
explicitly invoke the standard folder deletion behavior, which deletes
both the folder and its descendents from the local file system and
updates the workspace resource tree. It should return true
to indicate that the operation was attempted.
Returning false is the easy way for the implementation to
say "pass". It is equivalent to calling
tree.standardDeleteFolder and returning true.
The implementation of this method runs "below" the resources API and is
therefore very restricted in what resource API method it can call. The
list of useable methods includes most resource operations that read but
do not update the resource tree; resource operations that modify
resources and trigger deltas must not be called from within the dynamic
scope of the invocation of this method.
-
-
Parameters:
-
tree - the workspace resource tree; this object is only valid
for the duration of the invocation of this method, and must not be
used after this method has completed -
folder - the handle of the folder to delete; the receiver of
IResource.delete(int,IProgressMonitor)
-
updateFlags - bit-wise or of update flag constants as per
IResource.delete(int,IProgressMonitor)
-
monitor - the progress monitor, or null as per
IResource.delete(int,IProgressMonitor)
-
Returns:
-
false if this method declined to assume
responsibility for this operation, and true if this
method attempted to carry out the operation
-
Throws:
-
OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided. -
See Also:
-
IResource.delete(int,IProgressMonitor)
deleteProject
boolean deleteProject(
IResourceTree tree,
IProject project,
int updateFlags,
IProgressMonitor monitor)
- Implements
IResource.delete(int,IProgressMonitor) where the
receiver is a project. Returns true to accept responsibility
for implementing this operation as per the API contract.
In broad terms, a full re-implementation should delete the project content area in
the local file system if required (the files of a closed project should be deleted
only if the IResource.ALWAYS_DELETE_PROJECT_CONTENTS update
flag is specified; the files of an open project should be deleted unless the
the IResource.NEVER_DELETE_PROJECT_CONTENTS update flag is
specified). It should then call tree.deletedProject to complete
the updating of the workspace resource tree to reflect this fact. If unsuccessful
in deleting the project's files from the local file system, it should instead call
tree.failed to report the reason for the failure. In either case, it
should return true to indicate that the operation was attempted.
The FORCE update flag may need to be honored if the project is open:
unless FORCE is specified, the implementation must use
tree.isSynchronized to determine whether the project subtree is in
sync before attempting to delete it.
Note that local history is not maintained when a project is deleted,
regardless of the setting of the KEEP_HISTORY update flag.
A partial re-implementation should perform whatever pre-processing it needs
to do and then call tree.standardDeleteProject to explicitly
invoke the standard project deletion behavior. It should return true
to indicate that the operation was attempted.
Returning false is the easy way for the implementation to
say "pass". It is equivalent to calling
tree.standardDeleteProject and returning true.
The implementation of this method runs "below" the resources API and is
therefore very restricted in what resource API method it can call. The
list of useable methods includes most resource operations that read but
do not update the resource tree; resource operations that modify
resources and trigger deltas must not be called from within the dynamic
scope of the invocation of this method.
-
-
Parameters:
-
tree - the workspace resource tree; this object is only valid
for the duration of the invocation of this method, and must not be
used after this method has completed -
project - the handle of the project to delete; the receiver of
IResource.delete(int,IProgressMonitor)
-
updateFlags - bit-wise or of update flag constants as per
IResource.delete(int,IProgressMonitor)
-
monitor - the progress monitor, or null as per
IResource.delete(int,IProgressMonitor)
-
Returns:
-
false if this method declined to assume
responsibility for this operation, and true if this
method attempted to carry out the operation
-
Throws:
-
OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided. -
See Also:
-
IResource.delete(int,IProgressMonitor)
moveFile
boolean moveFile(
IResourceTree tree,
IFile source,
IFile destination,
int updateFlags,
IProgressMonitor monitor)
- Implements
IResource.move(IPath,int,IProgressMonitor) where
the receiver is a file. Returns true to accept
responsibility for implementing this operation as per the API contract.
On entry to this hook method, the following is guaranteed about the
workspace resource tree: the source file exists; the destination file
does not exist; the container of the destination file exists and is
accessible. In broad terms, a full re-implementation should move the file
in the local file system and then call tree.moveFile to
complete the updating of the workspace resource tree to reflect this
fact. If unsuccessful in moving the file in the local file system,
it should instead call tree.failed to report the reason for
the failure. In either case, it should return true to
indicate that the operation was attempted.
The FORCE update flag needs to be honored: unless
FORCE is specified, the implementation must use
tree.isSynchronized to determine whether the file is in sync before
attempting to move it.
The KEEP_HISTORY update flag needs to be honored as well; use
tree.addToLocalHistory to capture the contents of the file
(naturally, this must be before moving the file from the local file system).
An extending implementation should perform whatever pre-processing it needs
to do and then call tree.standardMoveFile to explicitly
invoke the standard file moving behavior, which moves both the file in the
local file system and updates the workspace resource tree. It should return
true to indicate that the operation was attempted.
Returning false is the easy way for the implementation to
say "pass". It is equivalent to calling
tree.standardMoveFile and returning true.
The implementation of this method runs "below" the resources API and is
therefore very restricted in what resource API method it can call. The
list of useable methods includes most resource operations that read but
do not update the resource tree; resource operations that modify
resources and trigger deltas must not be called from within the dynamic
scope of the invocation of this method.
-
-
Parameters:
-
tree - the workspace resource tree; this object is only valid
for the duration of the invocation of this method, and must not be
used after this method has completed -
source - the handle of the file to move; the receiver of
IResource.move(IPath,int,IProgressMonitor)
-
destination - the handle of where the file will move to; the handle
equivalent of the first parameter to
IResource.move(IPath,int,IProgressMonitor)
-
updateFlags - bit-wise or of update flag constants as per
IResource.move(IPath,int,IProgressMonitor)
-
monitor - the progress monitor, or null as per
IResource.move(IPath,int,IProgressMonitor)
-
Returns:
-
false if this method declined to assume
responsibility for this operation, and true if this
method attempted to carry out the operation
-
Throws:
-
OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided. -
See Also:
-
IResource.move(org.eclipse.core.runtime.IPath,int,IProgressMonitor)
moveFolder
boolean moveFolder(
IResourceTree tree,
IFolder source,
IFolder destination,
int updateFlags,
IProgressMonitor monitor)
- Implements
IResource.move(IPath,int,IProgressMonitor) where
the receiver is a project. Returns true to accept
responsibility for implementing this operation as per the API contract.
On entry to this hook method, the following is guaranteed about the
workspace resource tree: the source folder exists; the destination folder
does not exist; the container of the destination folder exists and is
accessible. In broad terms, a full re-implementation should move the
directory tree in the local file system and then call
tree.movedFolder to complete the updating of the workspace
resource tree to reflect this fact. If unsuccessful in moving the
directory or any of its descendents in the local file system,
call tree.failed to report each reason for failure.
In either case, return true to indicate that the operation
was attempted.
The FORCE update flag needs to be honored: unless
FORCE is specified, the implementation must use
tree.isSynchronized to determine whether the folder subtree is in sync
before attempting to move it.
The KEEP_HISTORY update flag needs to be honored as well; use
tree.addToLocalHistory to capture the contents of any files being
moved.
A partial re-implementation should perform whatever pre-processing it needs
to do and then call tree.standardMoveFolder to explicitly
invoke the standard folder move behavior, which move both the folder
and its descendents in the local file system and updates the workspace resource
tree. Return true to indicate that the operation was attempted.
Returning false is the easy way for the implementation to
say "pass". It is equivalent to calling
tree.standardDeleteFolder and returning true.
The implementation of this method runs "below" the resources API and is
therefore very restricted in what resource API method it can call. The
list of useable methods includes most resource operations that read but
do not update the resource tree; resource operations that modify
resources and trigger deltas must not be called from within the dynamic
scope of the invocation of this method.
-
-
Parameters:
-
tree - the workspace resource tree; this object is only valid
for the duration of the invocation of this method, and must not be
used after this method has completed -
source - the handle of the folder to move; the receiver of
IResource.move(IPath,int,IProgressMonitor)
-
destination - the handle of where the folder will move to; the
handle equivalent of the first parameter to
IResource.move(IPath,int,IProgressMonitor)
-
updateFlags - bit-wise or of update flag constants as per
IResource.move(IPath,int,IProgressMonitor)
-
monitor - the progress monitor, or null as per
IResource.move(IPath,int,IProgressMonitor)
-
Returns:
-
false if this method declined to assume
responsibility for this operation, and true if this
method attempted to carry out the operation
-
Throws:
-
OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided. -
See Also:
-
IResource.move(org.eclipse.core.runtime.IPath,int,IProgressMonitor)
moveProject
boolean moveProject(
IResourceTree tree,
IProject source,
IProjectDescription description,
int updateFlags,
IProgressMonitor monitor)
- Implements
IResource.move(IPath,int,IProgressMonitor) and
IResource.move(IProjectDescription,int,IProgressMonitor)
where the receiver is a project. Returns true to accept
responsibility for implementing this operation as per the API contracts.
On entry to this hook method, the source project is guaranteed to exist
and be open in the workspace resource tree. If the given description
contains a different name from that of the given project, then the
project is being renamed (and its content possibly relocated). If the
given description contains the same name as the given project, then the
project is being relocated but not renamed. When the project is being
renamed, the destination project is guaranteed not to exist in the
workspace resource tree.
Returning false is the easy way for the implementation to
say "pass". It is equivalent to calling
tree.standardMoveProject and returning true.
The implementation of this method runs "below" the resources API and is
therefore very restricted in what resource API method it can call. The
list of useable methods includes most resource operations that read but
do not update the resource tree; resource operations that modify
resources and trigger deltas must not be called from within the dynamic
scope of the invocation of this method.
-
-
Parameters:
-
tree - the workspace resource tree; this object is only valid
for the duration of the invocation of this method, and must not be
used after this method has completed -
source - the handle of the open project to move; the receiver of
IResource.move(IProjectDescription,int,IProgressMonitor)
or IResource.move(IPath,int,IProgressMonitor)
-
description - the new description of the project; the first
parameter to
IResource.move(IProjectDescription,int,IProgressMonitor), or
a copy of the project's description with the location changed to the
path given in the first parameter to
IResource.move(IPath,int,IProgressMonitor)
-
updateFlags - bit-wise or of update flag constants as per
IResource.move(IProjectDescription,int,IProgressMonitor)
or IResource.move(IPath,int,IProgressMonitor)
-
monitor - the progress monitor, or null as per
IResource.move(IProjectDescription,int,IProgressMonitor)
or IResource.move(IPath,int,IProgressMonitor)
-
Returns:
-
false if this method declined to assume
responsibility for this operation, and true if this method
attempted to carry out the operation
-
Throws:
-
OperationCanceledException
- if the operation is canceled.
Cancelation can occur even if no progress monitor is provided. -
See Also:
-
IResource.move(org.eclipse.core.runtime.IPath,int,IProgressMonitor),
IResource.move(IProjectDescription,int,IProgressMonitor)
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
