org.eclipse.core.resources
Interface IResourceChangeEvent

public interface IResourceChangeEvent

Resource change events describe changes to resources.

There are currently five different types of resource change events:

• After-the-fact batch reports of arbitrary creations, deletions and modifications to one or more resources expressed as a hierarchical resource delta. Event type is PRE_AUTO_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 any auto-building and happen whether or not auto-building is enabled. 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.
• After-the-fact batch reports of arbitrary creations, deletions and modifications to one or more resources expressed as a hierarchical resource delta. Event type is 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 immediately after any auto-building and happen whether or not auto-building is enabled. 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.
• After-the-fact batch reports of arbitrary creations, deletions and modifications to one or more resources expressed as a hierarchical resource delta. Event type is POST_CHANGE, and getDelta returns the hierarchical delta. The resource delta is rooted at the workspace root. These events are broadcast to interested parties immediately after any POST_AUTO_BUILD events 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.
• Before-the-fact reports of the impending closure of a single project. Event type is PRE_CLOSE, and getResource returns the project being closed. The workspace is closed for change during notification of these events.
• Before-the-fact reports of the impending deletion of a single project. Event type is 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 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 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

POST_CHANGE

public static final 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. See class comments for further details.

See Also:

getType(), getDelta(), Constant Field Values

PRE_CLOSE

public static final 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. See class comments for further details.

See Also:

getType(), getResource(), Constant Field Values

PRE_DELETE

public static final 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. See class comments for further details.

See Also:

getType(), getResource(), Constant Field Values

PRE_AUTO_BUILD

public static final int PRE_AUTO_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. See class comments for further details.

See Also:

getType(), getResource(), Constant Field Values

POST_AUTO_BUILD

public static final int POST_AUTO_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. See class comments for further details.

See Also:

getType(), getResource(), Constant Field Values

Method Detail

findMarkerDeltas

public IMarkerDelta[] findMarkerDeltas(String type,
                                       boolean includeSubtypes)

Returns all marker deltas of the specified type that are associated with resource deltas for this event. If 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.

Parameters:

type - the type of marker to consider, or null to indicate all types

includeSubtypes - whether or not to consider subtypes of the given type

Returns:

an array of marker deltas

Since:

2.0

getDelta

public IResourceDelta getDelta()

Returns a resource delta, rooted at the workspace, describing the set of changes that happened to resources in the workspace. Returns null if not applicable to this type of event.

Returns:

the resource delta, or null if not applicable

getResource

public IResource getResource()

Returns the resource in question. Returns null if not applicable to this type of event.

Returns:

the resource, or null if not applicable

getSource

public Object getSource()

Returns an object identifying the source of this event.

Returns:

an object identifying the source of this event

See Also:

EventObject

getType

public int getType()

Returns the type of event being reported.

Returns:

one of the event type constants

See Also:

POST_CHANGE, POST_AUTO_BUILD, PRE_AUTO_BUILD, PRE_CLOSE, PRE_DELETE