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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*******************************************************************************
* Copyright (c) 2000, 2017 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.internal.core.subscribers;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.team.core.subscribers.Subscriber;
import org.eclipse.team.core.synchronize.*;
import org.eclipse.team.internal.core.Policy;
/**
* This collector maintains a {@link SyncInfoSet} for a particular team subscriber keeping
* it up-to-date with both incoming changes and outgoing changes as they occur for
* resources in the workspace. The collector can be configured to consider all the subscriber's
* roots or only a subset.
* <p>
* The advantage of this collector is that it processes both resource and team
* subscriber deltas in a background thread.
* </p>
* @since 3.0
*/
public final class SubscriberSyncInfoCollector extends SubscriberResourceCollector {
private final SyncSetInputFromSubscriber subscriberInput;
private SyncSetInputFromSyncSet filteredInput;
private SubscriberSyncInfoEventHandler eventHandler;
private IResource[] roots;
/**
* Create a collector that collects out-of-sync resources that are children of
* the given roots. If the roots are <code>null</code>, then all out-of-sync resources
* from the subscriber are collected. An empty array of roots will cause no resources
* to be collected. The <code>start()</code> method must be called after creation
* to prime the collector's sync sets.
* @param subscriber the Subscriber
* @param roots the roots of the out-of-sync resources to be collected
*/
public SubscriberSyncInfoCollector(Subscriber subscriber, IResource[] roots) {
super(subscriber);
this.roots = roots;
this.eventHandler = new SubscriberSyncInfoEventHandler(subscriber, roots);
this.subscriberInput = eventHandler.getSyncSetInput();
filteredInput = new SyncSetInputFromSyncSet(subscriberInput.getSyncSet(), getEventHandler());
filteredInput.setFilter(new SyncInfoFilter() {
@Override
public boolean select(SyncInfo info, IProgressMonitor monitor) {
return true;
}
});
}
public void setProgressGroup(IProgressMonitor monitor, int ticks) {
getEventHandler().setProgressGroupHint(monitor, ticks);
}
/**
* Start the collector.
*/
public void start() {
eventHandler.start();
}
/**
* This causes the calling thread to wait any background collection of
* out-of-sync resources to stop before returning.
*
* @param monitor
* a progress monitor
*/
public void waitForCollector(IProgressMonitor monitor) {
monitor.worked(1);
int i = 0;
// wait for the event handler to process changes
while (true) {
try {
Thread.sleep(5);
} catch (InterruptedException e) {
}
Policy.checkCanceled(monitor);
// increment the counter or reset it if the job is running
i = (eventHandler.getEventHandlerJob().getState() == Job.NONE) ? i + 1 : 0;
// 50 positive checks in a row
if (i == 50)
break;
}
monitor.worked(1);
}
/**
* Clears this collector's sync info sets and causes them to be recreated from the
* associated <code>Subscriber</code>. The reset will occur in the background. If the
* caller wishes to wait for the reset to complete, they should call
* waitForCollector(IProgressMonitor).
*/
public void reset() {
eventHandler.reset(getRoots());
}
/**
* Disposes of the background job associated with this collector and de-registers
* all it's listeners. This method must be called when the collector is no longer
* referenced and could be garbage collected.
*/
@Override
public void dispose() {
eventHandler.shutdown();
subscriberInput.disconnect();
if(filteredInput != null) {
filteredInput.disconnect();
}
super.dispose();
}
/**
* Return the roots that are being considered by this collector.
* By default, the collector is interested in the roots of its
* subscriber. However, the set can be reduced using {@link #setRoots(IResource[])}.
* @return the roots
*/
@Override
public IResource[] getRoots() {
if (roots == null) {
return super.getRoots();
} else {
return roots;
}
}
/*
* Returns whether the collector is configured to collect for
* all roots of the subscriber or not
* @return <code>true</code> if the collector is considering all
* roots of the subscriber and <code>false</code> otherwise
*/
@Override
public boolean isAllRootsIncluded() {
return roots == null;
}
/**
* Return the event handler that performs the background processing for this collector.
* The event handler also serves the purpose of serializing the modifications and adjustments
* to the collector's sync sets in order to ensure that the state of the sets is kept
* consistent.
* @return Returns the eventHandler.
*/
protected SubscriberEventHandler getEventHandler() {
return eventHandler;
}
/**
* Return the <code>SyncInfoSet</code> that contains all the out-of-sync resources for the
* subscriber that are descendants of the roots of this collector. The set will contain only those resources that are children of the roots
* of the collector unless the roots of the collector has been set to <code>null</code>
* in which case all out-of-sync resources from the subscriber are collected.
* @return the subscriber sync info set
*/
public SyncInfoTree getSubscriberSyncInfoSet() {
return subscriberInput.getSyncSet();
}
public SyncInfoTree getSyncInfoSet() {
return filteredInput.getSyncSet();
}
/**
* Set the filter for this collector. Only elements that match the filter will
* be in the out sync info set.
* @param filter the sync info filter
*/
public void setFilter(SyncInfoFilter filter) {
filteredInput.setFilter(filter);
filteredInput.reset();
}
public void setRoots(IResource[] roots) {
this.roots = roots;
reset();
}
@Override
protected boolean hasMembers(IResource resource) {
return getSubscriberSyncInfoSet().hasMembers(resource);
}
@Override
protected void remove(IResource resource) {
eventHandler.remove(resource);
}
@Override
protected void change(IResource resource, int depth) {
eventHandler.change(resource, depth);
}
}
|
