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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/*******************************************************************************
* Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.runtime.utils;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.tcf.te.runtime.activator.CoreBundleActivator;
import org.eclipse.tcf.te.runtime.callback.Callback;
import org.eclipse.tcf.te.runtime.interfaces.callback.ICallback;
import org.eclipse.tcf.te.runtime.interfaces.tracing.ITraceIds;
/**
* Helper implementation to deal with progress monitors and callbacks.
*/
public final class ProgressHelper {
public static final int PROGRESS_DONE = 0;
public static final int PROGRESS_NONE = -1;
/**
* Checks if there was an error or the operation was canceled.
*
* @param caller
* The caller or <code>null</code>.
* @param status
* The status. <code>null</code> if status should not be checked.
* @param progress
* The progress monitor. <code>null</code> if cancel should not
* be checked.
* @param callback
* The callback to call on cancel or error.
*
* @return <code>false</code> if everything is OK.
*/
public static final boolean isCancelOrError(Object caller, IStatus status, IProgressMonitor progress, ICallback callback) {
if (status == null) status = Status.OK_STATUS;
if (!status.isOK() || (progress != null && progress.isCanceled())) {
if (status.getSeverity() == IStatus.CANCEL || (progress != null && progress.isCanceled())) {
status = new Status(IStatus.CANCEL, status.getPlugin(),
status.getCode(), status.getMessage(),
new OperationCanceledException());
} else if (status.getSeverity() == IStatus.ERROR) {
Throwable e = status.getException();
try {
throw e;
} catch (Throwable thrown) {
e = thrown;
}
CoreBundleActivator.getTraceHandler().trace(
status.getMessage(),
1,
ITraceIds.TRACE_CALLBACKS,
status.getSeverity(),
caller != null ? caller.getClass() : ProgressHelper.class);
status = new Status(IStatus.ERROR, status.getPlugin(), status.getCode(), status.getMessage(), e);
}
if (callback != null) {
if (caller instanceof ICallback) {
Callback.copyProperties((ICallback) caller, callback);
}
callback.done(caller, status);
}
return true;
}
return false;
}
/**
* Checks if the operation was canceled.
*
* @param caller
* The caller or <code>null</code>.
* @param progress
* The progress monitor. Must not be <code>null</code>
* @param callback
* The callback to call on cancel or error.
*
* @return <code>false</code> if everything is OK.
*/
public static final boolean isCancel(Object caller, IProgressMonitor progress, ICallback callback) {
Assert.isNotNull(progress);
return isCancel(caller, null, progress, callback);
}
/**
* Checks if the operation was canceled.
*
* @param caller
* The caller or <code>null</code>.
* @param status
* The status. Must not be <code>null</code>.
* @param callback
* The callback to call on cancel or error.
*
* @return <code>false</code> if everything is OK.
*/
public static final boolean isCancel(Object caller, IStatus status, ICallback callback) {
Assert.isNotNull(status);
return isCancel(caller, status, null, callback);
}
/**
* Checks if the operation was canceled.
*
* @param caller
* The caller or <code>null</code>.
* @param status
* The status. <code>null</code> if status should not be checked.
* @param progress
* The progress monitor. <code>null</code> if cancel should not
* be checked.
* @param callback
* The callback to call on cancel or error.
*
* @return <code>false</code> if everything is OK.
*/
public static final boolean isCancel(Object caller, IStatus status, IProgressMonitor progress, ICallback callback) {
if (status == null) status = Status.OK_STATUS;
if (status.getSeverity() == IStatus.CANCEL || (progress != null && progress.isCanceled())) {
status = new Status(IStatus.CANCEL, status.getPlugin(),
status.getCode(), status.getMessage(),
new OperationCanceledException());
if (callback != null) {
if (caller instanceof ICallback) {
Callback.copyProperties((ICallback) caller, callback);
}
callback.done(caller, status);
}
return true;
}
return false;
}
/**
* Checks if there was an error.
*
* @param caller
* The caller or <code>null</code>.
* @param status
* The status. <code>null</code> if status should not be checked.
* @param callback
* The callback to call on cancel or error.
*
* @return <code>false</code> if everything is OK.
*/
public static final boolean isError(Object caller, IStatus status, ICallback callback) {
if (status == null) status = Status.OK_STATUS;
if (!status.isOK() && status.getSeverity() != IStatus.CANCEL) {
if (status.getSeverity() == IStatus.ERROR) {
Throwable e = status.getException();
try {
throw e;
} catch (Throwable thrown) {
e = thrown;
}
CoreBundleActivator.getTraceHandler().trace(
status.getMessage(),
1,
ITraceIds.TRACE_CALLBACKS,
status.getSeverity(),
caller != null ? caller.getClass() : ProgressHelper.class);
status = new Status(IStatus.ERROR, status.getPlugin(), status.getCode(), status.getMessage(), e);
}
if (callback != null) {
if (caller instanceof ICallback) {
Callback.copyProperties((ICallback) caller, callback);
}
callback.done(caller, status);
}
return true;
}
return false;
}
/**
* Wraps the given progress monitor into a {@link SubProgressMonitor}. If
* the given monitor is <code>null</code>, a {@link NullProgressMonitor} is returned.
*
* @param progress
* The global progress monitor or <code>null</code>.
* @param ticksToUse
* The ticks to use.
*
* @return The progress monitor to use.
*/
public static final IProgressMonitor getProgressMonitor(IProgressMonitor progress, int ticksToUse) {
if (progress != null) {
progress = new SubProgressMonitor(progress, ticksToUse, SubProgressMonitor.PREPEND_MAIN_LABEL_TO_SUBTASK);
} else {
progress = new NullProgressMonitor();
}
return progress;
}
/**
* Start a task.
*
* @param progress
* The progress monitor or <code>null</code>.
* @param name
* The name (label) of the task.
* @param ticks
* The ticks for this task.
*/
public static final void beginTask(IProgressMonitor progress, String name, int ticks) {
if (progress != null) {
progress.beginTask("", ticks); //$NON-NLS-1$
progress.setTaskName(name);
}
}
/**
* Set a new task name.
*
* @param progress
* The progress monitor or <code>null</code>.
* @param taskName
* The name (label) of the task.
*/
public static final void setTaskName(IProgressMonitor progress, String taskName) {
if (progress != null) {
progress.setTaskName(taskName);
}
}
/**
* Set a new sub task name.
*
* @param progress
* The progress monitor or <code>null</code>.
* @param subTask
* The name (label) of the sub task.
*/
public static final void setSubTaskName(IProgressMonitor progress,
String subTaskName) {
if (progress != null) {
progress.subTask(subTaskName);
}
}
/**
* Add the given amount of worked steps to the progress monitor.
* <p>
* If the given amount of worked steps is less or equal than 0, the method
* will do nothing.
*
* @param progress
* The progress monitor or <code>null</code>.
* @param worked
* The amount of worked steps.
*/
public static final void worked(IProgressMonitor progress, int worked) {
if (progress != null && !progress.isCanceled() && worked > 0) {
progress.worked(worked);
}
}
/**
* Set the progress monitor done.
*
* @param progress
* The progress monitor or <code>null</code>.
*/
public static final void done(IProgressMonitor progress) {
if (progress != null) {
progress.setTaskName(""); //$NON-NLS-1$
progress.subTask(""); //$NON-NLS-1$
progress.done();
}
}
/**
* Set the progress monitor canceled.
*
* @param progress
* The progress monitor or <code>null</code>.
*/
public static final void cancel(IProgressMonitor progress) {
if (progress != null && !progress.isCanceled()) {
progress.setCanceled(true);
}
}
/**
* Get the canceled state of the progress monitor.
*
* @param progress
* The progress monitor or <code>null</code>.
*
* @return <code>True</code> if the progress monitor is not
* <code>null</code> and if the progress monitor is canceled.
*/
public static final boolean isCanceled(IProgressMonitor progress) {
if (progress != null) {
return progress.isCanceled();
}
return false;
}
}
|
