|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Resource change events describe changes to resources.
There are currently five different types of resource change events:
PRE_BUILD
, and getDelta
returns
the hierarchical delta. The resource delta is rooted at the
workspace root. These events are broadcast to interested parties immediately
before the first build of any kind in a workspace modifying operation. If
autobuilding is not enabled, these events still occur at times when autobuild
would have occurred. The workspace is open for change during notification of
these events. The delta reported in this event cycle is identical across
all listeners registered for this type of event.
Resource changes attempted during a PRE_AUTO_BUILD
callback
must be done in the thread doing the notification.
POST_AUTO_BUILD
, and getDelta
returns
the hierarchical delta. The resource delta is rooted at the
workspace root. These events are broadcast to interested parties at the
end of every workspace operation in which a build of any kind occurred.
If autobuilding is not enabled, these events still occur at times when autobuild
would have occurred. The workspace is open for change during notification of
these events. The delta reported in this event cycle is identical across
all listeners registered for this type of event.
Resource changes attempted during a POST_AUTO_BUILD
callback
must be done in the thread doing the notification.
POST_CHANGE
, and getDelta
returns
the hierarchical delta. The resource delta is rooted at the
workspace root. These events are broadcast to interested parties after
a set of resource changes and happen whether or not auto-building is enabled.
The workspace is closed for change during notification of these events.
The delta reported in this event cycle is identical across all listeners registered for
this type of event.
PRE_CLOSE
,
and getResource
returns the project being closed.
The workspace is closed for change during notification of these events.
PRE_DELETE
,
and getResource
returns the project being deleted.
The workspace is closed for change during notification of these events.
In order to handle additional event types that may be introduced in future releases of the platform, clients should do not write code that presumes the set of event types is closed.
This interface is not intended to be implemented by clients.
Field Summary | |
static int |
POST_AUTO_BUILD
Deprecated. This event type has been renamed to POST_BUILD |
static int |
POST_BUILD
Event type constant (bit mask) indicating an after-the-fact report of creations, deletions, and modifications to one or more resources expressed as a hierarchical resource delta as returned by getDelta .
|
static int |
POST_CHANGE
Event type constant (bit mask) indicating an after-the-fact report of creations, deletions, and modifications to one or more resources expressed as a hierarchical resource delta as returned by getDelta .
|
static int |
PRE_AUTO_BUILD
Deprecated. This event type has been renamed to PRE_BUILD |
static int |
PRE_BUILD
Event type constant (bit mask) indicating an after-the-fact report of creations, deletions, and modifications to one or more resources expressed as a hierarchical resource delta as returned by getDelta .
|
static int |
PRE_CLOSE
Event type constant (bit mask) indicating a before-the-fact report of the impending closure of a single project as returned by getResource .
|
static int |
PRE_DELETE
Event type constant (bit mask) indicating a before-the-fact report of the impending deletion of a single project as returned by getResource .
|
Method Summary | |
IMarkerDelta[] |
findMarkerDeltas(String type,
boolean includeSubtypes)
Returns all marker deltas of the specified type that are associated with resource deltas for this event. |
IResourceDelta |
getDelta()
Returns a resource delta, rooted at the workspace, describing the set of changes that happened to resources in the workspace. |
IResource |
getResource()
Returns the resource in question. |
Object |
getSource()
Returns an object identifying the source of this event. |
int |
getType()
Returns the type of event being reported. |
Field Detail |
public static final int POST_CHANGE
getDelta
.
See class comments for further details.
getType()
,
getDelta()
,
Constant Field Valuespublic static final int PRE_CLOSE
getResource
.
See class comments for further details.
getType()
,
getResource()
,
Constant Field Valuespublic static final int PRE_DELETE
getResource
.
See class comments for further details.
getType()
,
getResource()
,
Constant Field Valuespublic static final int PRE_AUTO_BUILD
PRE_BUILD
public static final int PRE_BUILD
getDelta
.
See class comments for further details.
getType()
,
getResource()
,
Constant Field Valuespublic static final int POST_AUTO_BUILD
POST_BUILD
public static final int POST_BUILD
getDelta
.
See class comments for further details.
getType()
,
getResource()
,
Constant Field ValuesMethod Detail |
public IMarkerDelta[] findMarkerDeltas(String type, boolean includeSubtypes)
includeSubtypes
is false
, only marker deltas whose type exactly matches
the given type are returned. Returns an empty array if there
are no matching marker deltas.
Calling this method is equivalent to walking the entire resource delta for this event, and collecting all marker deltas of a given type. The speed of this method will be proportional to the number of changed markers, regardless of the size of the resource delta tree.
type
- the type of marker to consider, or null
to indicate all typesincludeSubtypes
- whether or not to consider subtypes of the given type
public IResourceDelta getDelta()
null
if not applicable to this type of event.
null
if not
applicablepublic IResource getResource()
null
if not applicable to this type of event.
null
if not applicablepublic Object getSource()
EventObject
public int getType()
POST_CHANGE
,
POST_BUILD
,
PRE_BUILD
,
PRE_CLOSE
,
PRE_DELETE
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.