blob: 7e8ac987f38a93793923548ee945ba122623518b (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.core.synchronize;
import org.eclipse.core.resources.IResource;
/**
* An event generated when a {@link SyncInfoSet} collection is changed. The event contains
* a description of the changes which include added, changed and removed resources.
* In some cases, (e.g. when the change is too complicated to be efficiently described
* using the mechanisms provided by this interface) the event will be a reset. In these
* cases, the client should ignore any other contents of the event and reclaculate
* from scratch any state that is derived from the <code>SyncInfoSet</code> from
* which the event originated.
* <p>
* The mix of return types, <code>SyncInfo</code> and <code>IResource</code>is required as a result of an optimization
* included in {@link SyncInfoSet} collections that doesn't maintain <code>SyncInfo</code> objects
* for in-sync resources.
* </p>
* @see SyncInfoSet#addSyncSetChangedListener(ISyncInfoSetChangeListener)
* @see ISyncInfoSetChangeListener
* @since 3.0
*/
public interface ISyncInfoSetChangeEvent {
/**
* Returns newly added out-of-sync <code>SyncInfo</code> elements.
*
* @return newly added <code>SyncInfo</code> elements or an empty list if this event
* doesn't contain added resources.
*/
public SyncInfo[] getAddedResources();
/**
* Returns changed <code>SyncInfo</code> elements. The returned elements
* are still out-of-sync.
*
* @return changed <code>SyncInfo</code> elements or an empty list if this event
* doesn't contain changes resources.
*/
public SyncInfo[] getChangedResources();
/**
* Returns the removed <code>IResource</code> elements for which the set no longer
* contains on out-of-sync <code>SyncInfo</code>. The returned elements
* are all in-sync resources.
*
* @return removed <code>SyncInfo</code> elements or an empty list if this event
* doesn't contain removed resources.
*/
public IResource[] getRemovedResources();
/**
* Returns the {@link SyncInfoSet} that generated these events.
*
* @return the {@link SyncInfoSet} that generated these events.
*/
public SyncInfoSet getSet();
}
|
