Package org.eclipse.team.core.subscribers

Interface ISubscriberChangeEvent

All Known Implementing Classes:
SubscriberChangeEvent
public interface ISubscriberChangeEvent
A change event that describes a change in a resource that is or was supervised by a subscriber.
Since:
3.0
See Also:
Restriction:
Clients are not intended to implement. Instead subclass SubscriberChangeEvent.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NO_CHANGE
    Delta kind constant indicating that the resource has not been changed in any way
    static final int
    ROOT_ADDED
    Delta kind constant (bit mask) indicating that a team provider has been configured on the resource.
    static final int
    ROOT_REMOVED
    Delta kind constant (bit mask) indicating that a team provider has been de-configured on the resource.
    static final int
    SYNC_CHANGED
    Delta kind constant (bit mask) indicating that the synchronization state of a resource has changed.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getFlags()
    Return the flags that describe the type of change.
    IResource
    getResource()
    Return the resource whose state with respect to the subscriber has changed.
    Subscriber
    getSubscriber()
    Return the subscriber to which this change event applies.

  • Field Details

    • NO_CHANGE

      static final int NO_CHANGE
      Delta kind constant indicating that the resource has not been changed in any way
      See Also:

    • SYNC_CHANGED

      static final int SYNC_CHANGED
      Delta kind constant (bit mask) indicating that the synchronization state of a resource has changed.
      See Also:

    • ROOT_ADDED

      static final int ROOT_ADDED
      Delta kind constant (bit mask) indicating that a team provider has been configured on the resource.
      See Also:

    • ROOT_REMOVED

      static final int ROOT_REMOVED
      Delta kind constant (bit mask) indicating that a team provider has been de-configured on the resource.
      See Also:

  • Method Details

    • getFlags

      int getFlags()
      Return the flags that describe the type of change. The returned value should be ANDed with the change type flags to determine whether the change event is of a particular type. For example, 
       if (event.getFlags() & ISubscriberChangeEvent.SYNC_CHANGED) {
        // the sync info for the resource has changed
 }
      Returns:
      the flags that describe the type of change

    • getResource

      IResource getResource()
      Return the resource whose state with respect to the subscriber has changed.
      Returns:
      the resource whose state with respect to the subscriber has changed

    • getSubscriber

      Subscriber getSubscriber()
      Return the subscriber to which this change event applies.
      Returns:
      the subscriber to which this change event applies