Package com.e1c.langtool.builder

Interface IBuiltResourceQueue

All Superinterfaces:
IManagedService
All Known Implementing Classes:
BuiltResourceQueue
public interface IBuiltResourceQueue extends IManagedService
A service that allows to store all paths to built resources and process them by builder participants.

  • Method Details

    • add

      void add(org.eclipse.core.resources.IProject project, BuiltResource resource)
      Adds a new built resource for the given project to the storage.
      Parameters:
      project - a project of built resource
      resource - a built resource

    • asyncInvokeParticipants

      org.eclipse.core.runtime.jobs.Job asyncInvokeParticipants(org.eclipse.core.resources.IProject project, Runnable callback)
      Asynchronously starts participants to process this queue for the given project.

      Note that calling of this method removes all processed resources from storage.

      Parameters:
      project - a project for which resources will be processed
      callback - a function that will be asynchronously called when all resources are processed
      Returns:
      a job created to run a processing task. Note that this job may be not run.

    • syncInvokeParticipants

      void syncInvokeParticipants(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
      Synchronously starts participants to process this queue for the given project.

      Note that calling of this method removes all processed resources from storage.

      Parameters:
      project - a project for which resources will be processed
      monitor - a progress monitor

    • addQueuePostChangeListener

      void addQueuePostChangeListener(IBuiltResourceQueue.IQueueChangeListener listener)
      Adds a new post change listener to listeners list.
      Parameters:
      listener - a listener to register

    • removeQueuePostChangeListener

      void removeQueuePostChangeListener(IBuiltResourceQueue.IQueueChangeListener listener)
      Removes a post change listener form listeners list.
      Parameters:
      listener - a listener to unregister

    • getBuiltProjects

      Collection<org.eclipse.core.resources.IProject> getBuiltProjects()
      Returns a collection of projects that contain resources stored at this queue.
      Returns:
      a collection of projects that contain resources stored at this queue

    • mute

      void mute()
      Blocks all notifications of registered IBuiltResourceQueue.IQueueChangeListeners.
      See Also:

    • unmute

      void unmute()
      Unblocks all notifications of registered IBuiltResourceQueue.IQueueChangeListeners.
      See Also:

    • unmute

      void unmute(QueueChangeEvent event)
      Unblocks all notifications of registered IBuiltResourceQueue.IQueueChangeListeners and asynchronously notifies all listeners by the given event.
      Parameters:
      event - an event will be sent to registered listeners

    • isMute

      boolean isMute()
      Returns true if this queue is mute by mute() method.
      Returns:
      true
      See Also: