org.eclipse.team.ui.synchronize
Interface ISynchronizeScope

All Known Implementing Classes:

AbstractSynchronizeScope

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.

This interface is not intended to be implemented by clients

Since:

3.0

See Also:

SubscriberParticipant

Field Summary

static String	CONTAINMENT Property used to indicate that the roots of the scope have not changes but the resources covered by the scope have.
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.
boolean	contains(IResource resource) Return whether the given resource is contained in this scope.
void	dispose() Dispose of the scope when it is no longer needed.
String	getName() Return the name of the scope
org.eclipse.core.resources.mapping.ResourceMapping[]	getResourceMappings() Return the resource mappings that define this scope.
IResource[]	getRoots() Return the root resources that define this scope.
void	removePropertyChangeListener(IPropertyChangeListener listener) Remove a property change listener.

Field Detail

ROOTS

public static final String ROOTS

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

See Also:

Constant Field Values

NAME

public static final String NAME

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

Since:

3.1

See Also:

Constant Field Values

CONTAINMENT

public static final String CONTAINMENT

Property used to indicate that the roots of the scope have not changes but the resources covered by the scope have.

Since:

3.2

See Also:

contains(IResource), Constant Field Values

Method Detail

getName

public String getName()

Return the name of the scope

Returns:

the name of the scope

getRoots

public 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

public void addPropertyChangeListener(IPropertyChangeListener listener)

Add a property change listener that will get invoked when a property of the receiver changes.

Parameters:

listener -

removePropertyChangeListener

public void removePropertyChangeListener(IPropertyChangeListener listener)

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

Parameters:

listener -

dispose

public void dispose()

Dispose of the scope when it is no longer needed.

contains

public boolean contains(IResource resource)

Return whether the given resource is contained in this scope.

Parameters:

resource - the resource to be tested

Returns:

whether the given resource is contained in this scope

Since:

3.2

getResourceMappings

public org.eclipse.core.resources.mapping.ResourceMapping[] getResourceMappings()

Return the resource mappings that define this scope.

Returns:

the resource mappings that define this scope

Since:

3.2