|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A resource delta represents changes in the state of a resource tree between two discrete points in time.
This interface is not intended to be implemented by clients.
Resource deltas implement the IAdaptable
interface;
extensions are managed by the platform's adapter manager.
IResource
,
Platform.getAdapterManager()
Field Summary | |
static int |
ADDED
Delta kind constant (bit mask) indicating that the resource has been added to its parent. |
static int |
ADDED_PHANTOM
Delta kind constant (bit mask) indicating that a phantom resource has been added at the location of the delta node. |
static int |
ALL_WITH_PHANTOMS
The bit mask which describes all possible delta kinds, including ones involving phantoms. |
static int |
CHANGED
Delta kind constant (bit mask) indicating that the resource has been changed. |
static int |
CONTENT
Change constant (bit mask) indicating that the content of the resource has changed. |
static int |
DESCRIPTION
Change constant (bit mask) indicating that a project's description has changed. |
static int |
MARKERS
Change constant (bit mask) indicating that the resource's markers have changed. |
static int |
MOVED_FROM
Change constant (bit mask) indicating that the resource was moved from another location. |
static int |
MOVED_TO
Change constant (bit mask) indicating that the resource was moved to another location. |
static int |
NO_CHANGE
Delta kind constant indicating that the resource has not been changed in any way |
static int |
OPEN
Change constant (bit mask) indicating that the resource was opened or closed. |
static int |
REMOVED
Delta kind constant (bit mask) indicating that the resource has been removed from its parent. |
static int |
REMOVED_PHANTOM
Delta kind constant (bit mask) indicating that a phantom resource has been removed from the location of the delta node. |
static int |
REPLACED
Change constant (bit mask) indicating that the resource has been replaced by another at the same location (i.e., the resource has been deleted and then added). |
static int |
SYNC
Change constant (bit mask) indicating that the resource's sync status has changed. |
static int |
TYPE
Change constant (bit mask) indicating that the type of the resource has changed |
Method Summary | |
void |
accept(IResourceDeltaVisitor visitor)
Accepts the given visitor. |
void |
accept(IResourceDeltaVisitor visitor,
boolean includePhantoms)
Accepts the given visitor. |
void |
accept(IResourceDeltaVisitor visitor,
int memberFlags)
Accepts the given visitor. |
IResourceDelta |
findMember(IPath path)
Finds and returns the descendent delta identified by the given path in this delta, or null if no such descendent exists. |
IResourceDelta[] |
getAffectedChildren()
Returns resource deltas for all children of this resource which were added, removed, or changed. |
IResourceDelta[] |
getAffectedChildren(int kindMask)
Returns resource deltas for all children of this resource whose kind is included in the given mask. |
IResourceDelta[] |
getAffectedChildren(int kindMask,
int memberFlags)
Returns resource deltas for all children of this resource whose kind is included in the given mask. |
int |
getFlags()
Returns flags which describe in more detail how a resource has been affected. |
IPath |
getFullPath()
Returns the full, absolute path of this resource delta. |
int |
getKind()
Returns the kind of this resource delta. |
IMarkerDelta[] |
getMarkerDeltas()
Returns the changes to markers on the corresponding resource. |
IPath |
getMovedFromPath()
Returns the full path (in the "before" state) from which this resource (in the "after" state) was moved. |
IPath |
getMovedToPath()
Returns the full path (in the "after" state) to which this resource (in the "before" state) was moved. |
IPath |
getProjectRelativePath()
Returns the project-relative path of this resource delta. |
IResource |
getResource()
Returns a handle for the affected resource. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Field Detail |
public static final int NO_CHANGE
getKind()
,
Constant Field Valuespublic static final int ADDED
getKind()
,
Constant Field Valuespublic static final int REMOVED
getKind()
,
Constant Field Valuespublic static final int CHANGED
getKind()
,
Constant Field Valuespublic static final int ADDED_PHANTOM
getKind()
,
Constant Field Valuespublic static final int REMOVED_PHANTOM
getKind()
,
Constant Field Valuespublic static final int ALL_WITH_PHANTOMS
getKind()
,
Constant Field Valuespublic static final int CONTENT
getFlags()
,
Constant Field Valuespublic static final int MOVED_FROM
getMovedFromPath()
.
getFlags()
,
Constant Field Valuespublic static final int MOVED_TO
getMovedToPath()
.
getFlags()
,
Constant Field Valuespublic static final int OPEN
getFlags()
,
Constant Field Valuespublic static final int TYPE
getFlags()
,
Constant Field Valuespublic static final int SYNC
getFlags()
,
Constant Field Valuespublic static final int MARKERS
getFlags()
,
Constant Field Valuespublic static final int REPLACED
getFlags()
,
Constant Field Valuespublic static final int DESCRIPTION
getFlags()
,
Constant Field ValuesMethod Detail |
public void accept(IResourceDeltaVisitor visitor) throws CoreException
ADDED
, REMOVED
,
and CHANGED
.
The visitor's visit
method is called with this
resource delta if applicable. If the visitor returns true
,
the resource delta's children are also visited.
This is a convenience method, fully equivalent to
accept(visitor, IResource.NONE)
.
Although the visitor will be invoked for this resource delta, it will not be
invoked for any team-private member resources.
visitor
- the visitor
CoreException
- if the visitor failed with this exception.IResourceDeltaVisitor.visit(org.eclipse.core.resources.IResourceDelta)
public void accept(IResourceDeltaVisitor visitor, boolean includePhantoms) throws CoreException
visit
method is called with this
resource delta. If the visitor returns true
,
the resource delta's children are also visited.
This is a convenience method, fully equivalent to:
accept(visitor, includePhantoms ? INCLUDE_PHANTOMS : IResource.NONE);Although the visitor will be invoked for this resource delta, it will not be invoked for any team-private member resources.
visitor
- the visitorincludePhantoms
- true
if phantom resources are
of interest; false
if phantom resources are not of
interest
CoreException
- if the visitor failed with this exception.accept(IResourceDeltaVisitor)
,
IResource.isPhantom()
,
IResourceDeltaVisitor.visit(org.eclipse.core.resources.IResourceDelta)
public void accept(IResourceDeltaVisitor visitor, int memberFlags) throws CoreException
visit
method is called with this
resource delta. If the visitor returns true
,
the resource delta's children are also visited.
The member flags determine which child deltas of this resource delta will be visited. The visitor will always be invoked for this resource delta.
If the INCLUDE_PHANTOMS
member flag is not specified
(recommended), only child resource deltas involving existing resources will be visited
(kinds ADDED
, REMOVED
, and CHANGED
).
If the INCLUDE_PHANTOMS
member flag is specified,
the result will also include additions and removes of phantom resources
(kinds ADDED_PHANTOM
and REMOVED_PHANTOM
).
If the INCLUDE_TEAM_PRIVATE_MEMBERS
member flag is not specified
(recommended), resource deltas involving team private member resources will be
excluded from the visit. If the INCLUDE_TEAM_PRIVATE_MEMBERS
member
flag is specified, the visit will also include additions and removes of
team private member resources.
visitor
- the visitormemberFlags
- bit-wise or of member flag constants
(IContainer.INCLUDE_PHANTOMS
and INCLUDE_TEAM_PRIVATE_MEMBERS
)
indicating which members are of interest
CoreException
- if the visitor failed with this exception.IResource.isPhantom()
,
IResource.isTeamPrivateMember()
,
IContainer.INCLUDE_PHANTOMS
,
IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
,
IResourceDeltaVisitor.visit(org.eclipse.core.resources.IResourceDelta)
public IResourceDelta findMember(IPath path)
null
if no such descendent exists.
The supplied path may be absolute or relative; in either case, it is
interpreted as relative to this delta. Trailing separators are ignored.
If the path is empty this delta is returned.
This is a convenience method to avoid manual traversal of the delta tree in cases where the listener is only interested in changes to particular resources. Calling this method will generally be faster than manually traversing the delta to a particular descendent.
path
- the path of the desired descendent delta
null
if no such
descendent exists in the deltapublic IResourceDelta[] getAffectedChildren()
This is a convenience method, fully equivalent to:
getAffectedChildren(ADDED | REMOVED | CHANGED, IResource.NONE);Team-private member resources are not included in the result; neither are phantom resources.
ADDED
,
REMOVED
,
CHANGED
,
getAffectedChildren(int,int)
public IResourceDelta[] getAffectedChildren(int kindMask)
IResourceDelta
kind constants.
Returns an empty array if there are no affected children.
This is a convenience method, fully equivalent to:
getAffectedChildren(kindMask, IResource.NONE);Team-private member resources are not included in the result.
kindMask
- a mask formed by the bitwise or of IResourceDelta
delta kind constants
ADDED
,
REMOVED
,
CHANGED
,
ADDED_PHANTOM
,
REMOVED_PHANTOM
,
ALL_WITH_PHANTOMS
,
getAffectedChildren(int,int)
public IResourceDelta[] getAffectedChildren(int kindMask, int memberFlags)
IResourceDelta
kind constants.
Returns an empty array if there are no affected children.
If the INCLUDE_TEAM_PRIVATE_MEMBERS
member flag is not specified,
(recommended), resource deltas involving team private member resources will be
excluded. If the INCLUDE_TEAM_PRIVATE_MEMBERS
member
flag is specified, the result will also include resource deltas of the
specified kinds to team private member resources.
Specifying the INCLUDE_PHANTOMS
member flag is equivalent
to including ADDED_PHANTOM
and REMOVED_PHANTOM
in the kind mask.
kindMask
- a mask formed by the bitwise or of IResourceDelta
delta kind constantsmemberFlags
- bit-wise or of member flag constants
(IContainer.INCLUDE_PHANTOMS
and INCLUDE_TEAM_PRIVATE_MEMBERS
)
indicating which members are of interest
ADDED
,
REMOVED
,
CHANGED
,
ADDED_PHANTOM
,
REMOVED_PHANTOM
,
ALL_WITH_PHANTOMS
,
IContainer.INCLUDE_PHANTOMS
,
IContainer.INCLUDE_TEAM_PRIVATE_MEMBERS
public int getFlags()
The following codes (bit masks) are used when kind is CHANGED
, and
also when the resource is involved in a move:
CONTENT
- The bytes contained by the resource have been altered.
This flag is only valid for file resources.DESCRIPTION
- The description of the project has been altered.
This flag is only valid for project resources.OPEN
- The project's open/closed state has changed.
If it is not open, it was closed, and vice versa. This flag is only valid for project resources.TYPE
- The resource (a folder or file) has changed its type.SYNC
- The resource's sync status has changed.MARKERS
- The resource's markers have changed.REPLACED
- The resource (and all its properties)
was deleted (either by a delete or move), and was subsequently re-created
(either by a create, move, or copy).REMOVED
(or CHANGED
in conjunction with REPLACED
):
MOVED_TO
- The resource has moved.
getMovedToPath
will return the path of where it was moved to.ADDED
(or CHANGED
in conjunction with REPLACED
):
MOVED_FROM
- The resource has moved.
getMovedFromPath
will return the path of where it was moved from.REMOVED
, with flag MOVED_TO
,
and getMovedToPath
on A will return the path for B.
B will have kind ADDED
, with flag MOVED_FROM
,
and getMovedFromPath
on B will return the path for A.
B's other flags will describe any other changes to the resource, as compared
to its previous location at A.
Note that the move flags only describe the changes to a single resource; they don't necessarily imply anything about the parent or children of the resource. If the children were moved as a consequence of a subtree move operation, they will have corresponding move flags as well.
Note that it is possible for a file resource to be replaced in the workspace by a folder resource (or the other way around). The resource delta, which is actually expressed in terms of paths instead or resources, shows this as a change to either the content or children.
CONTENT
,
DESCRIPTION
,
OPEN
,
MOVED_TO
,
MOVED_FROM
,
TYPE
,
SYNC
,
MARKERS
,
REPLACED
,
getKind()
,
getMovedFromPath()
,
getMovedToPath()
,
IResource.move(org.eclipse.core.resources.IProjectDescription, boolean, boolean, org.eclipse.core.runtime.IProgressMonitor)
public IPath getFullPath()
Note: the returned path never has a trailing separator.
IResource.getFullPath()
,
getProjectRelativePath()
public int getKind()
ADDED
,
REMOVED
, CHANGED
.
When phantom resources have been explicitly requested,
there are two additional kinds: ADDED_PHANTOM
and REMOVED_PHANTOM
.
ADDED
,
REMOVED
,
CHANGED
,
ADDED_PHANTOM
,
REMOVED_PHANTOM
public IMarkerDelta[] getMarkerDeltas()
public IPath getMovedFromPath()
MOVED_FROM
change flag is set; otherwise,
null
is returned.
Note: the returned path never has a trailing separator.
null
getMovedToPath()
,
getFullPath()
,
getFlags()
public IPath getMovedToPath()
MOVED_TO
change flag is set; otherwise,
null
is returned.
Note: the returned path never has a trailing separator.
null
getMovedFromPath()
,
getFullPath()
,
getFlags()
public IPath getProjectRelativePath()
A resource's project-relative path indicates the route from the project to the resource. Within a workspace, there is exactly one such path for any given resource. The returned path never has a trailing separator.
IResource.getProjectRelativePath()
,
getFullPath()
,
Path.EMPTY
public IResource getResource()
For additions (ADDED
), this handle describes the newly-added resource; i.e.,
the one in the "after" state.
For changes (CHANGED
), this handle also describes the resource in the "after"
state. When a file or folder resource has changed type, the
former type of the handle can be inferred.
For removals (REMOVED
), this handle describes the resource in the "before"
state. Even though this resource would not normally exist in the
current workspace, the type of resource that was removed can be
determined from the handle.
For phantom additions and removals (ADDED_PHANTOM
and REMOVED_PHANTOM
), this is the handle of the phantom resource.
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |