Eclipse Plug-in Developer Guide (Galileo) - ISynchronizeScope (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: SubscriberParticipant
Restriction:: This interface is not intended to be implemented by clients.

Field Summary

static String NAME
          Property used to indicate when the name of the scope has changed.

static String ROOTS
          Property used to indicate when the roots of the scope have changed.

Method Summary

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 Detail

ROOTS

static final 
String ROOTS

Property used to indicate when the roots of the scope have changed.

See Also:: Constant Field Values

NAME

static final 
String NAME

Property used to indicate when the name of the scope has changed.

Since:: 3.1
See Also:: Constant Field Values

Method Detail

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 -

removePropertyChangeListener

void removePropertyChangeListener(
IPropertyChangeListener listener)

Remove a property change listener. Removing an unregistered listener has no effect.

Parameters:: listener -

dispose

void dispose()

Dispose of the scope when it is no longer needed.