Package org.eclipse.team.ui.synchronize

Interface ISynchronizeScope

All Known Implementing Classes:
AbstractSynchronizeScope, ResourceScope, WorkingSetScope, WorkspaceScope
public interface ISynchronizeScope
A synchronize scope defines the set of resources involved in a synchronization. Instance of this interface are used to scope the resources of a created SubscriberParticipant.
Since:
3.0
See Also:
Restriction:
This interface is not intended to be implemented by clients.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    Property used to indicate when the name of the scope has changed.
    static final String
    ROOTS
    Property used to indicate when the roots of the scope have changed.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPropertyChangeListener(IPropertyChangeListener listener)
    Add a property change listener that will get invoked when a property of the receiver changes.
    void
    dispose()
    Dispose of the scope when it is no longer needed.
    String
    getName()
    Return the name of the scope
    IResource[]
    getRoots()
    Return the root resources that define this scope.
    void
    removePropertyChangeListener(IPropertyChangeListener listener)
    Remove a property change listener.

  • Field Details

    • ROOTS

      static final String ROOTS
      Property used to indicate when the roots of the scope have changed.
      See Also:

    • NAME

      static final String NAME
      Property used to indicate when the name of the scope has changed.
      Since:
      3.1
      See Also:

  • Method Details

    • getName

      String getName()
      Return the name of the scope
      Returns:
      the name of the scope

    • getRoots

      IResource[] getRoots()
      Return the root resources that define this scope. A return value of null indicates that the participant should use its default set of resources.
      Returns:
      the root resources or null

    • addPropertyChangeListener

      void addPropertyChangeListener(IPropertyChangeListener listener)
      Add a property change listener that will get invoked when a property of the receiver changes.
      Parameters:
      listener - The listener to add.

    • removePropertyChangeListener

      void removePropertyChangeListener(IPropertyChangeListener listener)
      Remove a property change listener. Removing an unregistered listener has no effect.
      Parameters:
      listener - The listener to remove.

    • dispose

      void dispose()
      Dispose of the scope when it is no longer needed.