blob: 6e625c3b39668b8c9a3022b64fa432b718415add (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
/*******************************************************************************
* Copyright (c) 2000, 2008 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.ui.synchronize;
import org.eclipse.core.resources.IResource;
import org.eclipse.jface.util.IPropertyChangeListener;
/**
* 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 {@link SubscriberParticipant}.
*
* @see SubscriberParticipant
* @since 3.0
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISynchronizeScope {
/**
* Property used to indicate when the roots of the scope have changed.
*/
public static final String ROOTS = "prop_roots"; //$NON-NLS-1$
/**
* Property used to indicate when the name of the scope has changed.
* @since 3.1
*/
public static final String NAME = "prop_name"; //$NON-NLS-1$
/**
* Return the name of the scope
*
* @return the name of the scope
*/
public String getName();
/**
* Return the root resources that define this scope. A return value
* of <code>null</code> indicates that the participant should use
* its default set of resources.
*
* @return the root resources or <code>null</code>
*/
public IResource[] getRoots();
/**
* Add a property change listener that will get invoked when a
* property of the receiver changes.
*
* @param listener The listener to add.
*/
public void addPropertyChangeListener(IPropertyChangeListener listener);
/**
* Remove a property change listener. Removing an unregistered listener
* has no effect.
*
* @param listener The listener to remove.
*/
public void removePropertyChangeListener(IPropertyChangeListener listener);
/**
* Dispose of the scope when it is no longer needed.
*/
public void dispose();
}
|
