Package org.eclipse.ui

Interface IWorkingSetUpdater

All Known Subinterfaces:
IWorkingSetUpdater2
public interface IWorkingSetUpdater
An IWorkingSetUpdater can be used to dynamically update the content of a working set.

A working set updater manages a set of working sets. It is contributed via the attribute updaterClass of the org.eclipse.ui.workingSets extension point. Extensions of this extension point must therefore implement this interface.

API under construction and subject to change at any time.

Since:
3.1

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(IWorkingSet workingSet)
    Adds a working set to this updater.
    boolean
    contains(IWorkingSet workingSet)
    Returns true if the updater contains the given working set; otherwise false is returned.
    void
    dispose()
    Disposes this working set updater.
    boolean
    remove(IWorkingSet workingSet)
    Removes a working set from this updater.

  • Method Details

    • add

      void add(IWorkingSet workingSet)
      Adds a working set to this updater.
      Parameters:
      workingSet - the working set to add to this updater

    • remove

      boolean remove(IWorkingSet workingSet)
      Removes a working set from this updater.
      Parameters:
      workingSet - the working set to remove
      Returns:
      true if the updater changed (e.g. the element got removed)

    • contains

      boolean contains(IWorkingSet workingSet)
      Returns true if the updater contains the given working set; otherwise false is returned.
      Parameters:
      workingSet - the parameter to check
      Returns:
      whether the updater contains the given working set

    • dispose

      void dispose()
      Disposes this working set updater. Implementations of this method typically remove listeners from some delta providers.