org.eclipse.sphinx.platform.resources

Class ResourceChangeDispatcher

java.lang.Object

org.eclipse.sphinx.platform.resources.ResourceChangeDispatcher

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.resources.IResourceChangeListener

public class ResourceChangeDispatcher
extends java.lang.Object
implements org.eclipse.core.resources.IResourceChangeListener

The resource change listeners registered to the Eclipse platform are notified of workspace changes. When a resource change event is triggered, the listeners are notified in broadcast, but the notification sequence is not guaranteed. This new resource change dispatcher listener is added for tracking resource changes. All the other listeners are registered to this dispatcher and marked with a phase of PRE, MAIN or POST. When a workspace change happens, the resource change dispatcher listener is notified, and it will dispatch the resource change event to the registered listeners in the sequence of PRE, MAIN, POST.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceChangeDispatcher.ResourceChangeDispatchPhase An enumeration phase to indicate the priority that the resource change event will be dispatched to the registered listeners.
class	ResourceChangeDispatcher.ResourceChangeListenerDescriptor A resource change listener descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceChangeDispatcher	INSTANCE The singleton instance.

Method Summary

Modifier and Type	Method and Description
void	addResourceChangeListener(org.eclipse.core.resources.IResourceChangeListener listener, int eventMask, ResourceChangeDispatcher.ResourceChangeDispatchPhase dispatchPhase) Adds the given listener for resource change events to this dispatcher.
void	addResourceChangeListener(org.eclipse.core.resources.IResourceChangeListener listener, ResourceChangeDispatcher.ResourceChangeDispatchPhase dispatchPhase) Adds the given listener for resource change events to this dispatcher.
protected void	dispatchResourceChanged(org.eclipse.core.resources.IResourceChangeEvent event, java.util.Collection<ResourceChangeDispatcher.ResourceChangeListenerDescriptor> listenerDescriptors) Dispatches resource change event to the collection of listener descriptors.
java.util.Map<ResourceChangeDispatcher.ResourceChangeDispatchPhase,java.util.Collection<ResourceChangeDispatcher.ResourceChangeListenerDescriptor>>	getResourceChangeListeners()
void	removeResourceChangeListener(org.eclipse.core.resources.IResourceChangeListener listener) Removes the given resource change listener from this dispatcher.
void	resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final ResourceChangeDispatcher INSTANCE

The singleton instance.

Method Detail

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Specified by:

resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

dispatchResourceChanged

protected void dispatchResourceChanged(org.eclipse.core.resources.IResourceChangeEvent event,
                                       java.util.Collection<ResourceChangeDispatcher.ResourceChangeListenerDescriptor> listenerDescriptors)

Dispatches resource change event to the collection of listener descriptors.

Parameters:

event - resource change event

listenerDescriptors - a collection of listener descriptors

addResourceChangeListener

public void addResourceChangeListener(org.eclipse.core.resources.IResourceChangeListener listener,
                                      ResourceChangeDispatcher.ResourceChangeDispatchPhase dispatchPhase)

Adds the given listener for resource change events to this dispatcher. A resource change dispatch phase may be used to specify the dispatch priority wrt to other registered listeners. Has no effect if an identical listener is already registered for the same dispatch phase.

This method is equivalent to:

 addResourceChangeListener(listener, IResourceChangeEvent.PRE_CLOSE | IResourceChangeEvent.PRE_DELETE | IResourceChangeEvent.POST_CHANGE,
                dispatchPhase);
 

Parameters:

listener - the listener

dispatchPhase - the resource change dispatch phase that indicates the dispatch priority wrt to other registered listeners

See Also:

IResourceChangeListener, IResourceChangeEvent, #addResourceChangeListener(IResourceChangeListener, int), removeResourceChangeListener(IResourceChangeListener)

addResourceChangeListener

public void addResourceChangeListener(org.eclipse.core.resources.IResourceChangeListener listener,
                                      int eventMask,
                                      ResourceChangeDispatcher.ResourceChangeDispatchPhase dispatchPhase)

Adds the given listener for resource change events to this dispatcher. A resource change dispatch phase may be used to specify the dispatch priority wrt to other registered listeners. Has no effect if an identical listener is already registered for these events and the same dispatch phase. After completion of this method, the given listener will be registered for exactly the specified events. If they were previously registered for other events, they will be de-registered.

Once registered, a listener starts receiving notification of changes to resources in the workspace. The resource deltas in the resource change event are rooted at the workspace root. Most resource change notifications occur well after the fact; the exception is pre-notification of impending project closures and deletions. The listener continues to receive notifications until it is replaced or removed.

Listeners can listen for several types of event as defined in IResourceChangeEvent. Clients are free to register for any number of event types however if they register for more than one, it is their responsibility to ensure they correctly handle the case where the same resource change shows up in multiple notifications. Clients are guaranteed to receive only the events for which they are registered.

Parameters:

listener - the listener

eventMask - the bit-wise OR of all event types of interest to the listener

dispatchPhase - the resource change dispatch phase that indicates the dispatch priority wrt to other registered listeners

See Also:

IResourceChangeListener, IResourceChangeEvent, removeResourceChangeListener(IResourceChangeListener)

getResourceChangeListeners

public java.util.Map<ResourceChangeDispatcher.ResourceChangeDispatchPhase,java.util.Collection<ResourceChangeDispatcher.ResourceChangeListenerDescriptor>> getResourceChangeListeners()

removeResourceChangeListener

public void removeResourceChangeListener(org.eclipse.core.resources.IResourceChangeListener listener)

Removes the given resource change listener from this dispatcher. Has no effect if an identical listener is not registered.

Parameters:

listener - the listener

See Also:

IResourceChangeListener, #addResourceChangeListener(IResourceChangeListener)