Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 84acf38671e6ec3088a5d7c9ee83544e81d0611a (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
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
/**
 * Copyright (c) 2005-2012 IBM Corporation 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:
 *   IBM - Initial API and implementation
 */
package org.eclipse.emf.common.util;

import java.io.PrintStream;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IProgressMonitorWithBlocking;
import org.eclipse.core.runtime.IStatus;


/**
 * The most basic implementation of a task monitor.
 */
public class BasicMonitor implements Monitor 
{
  private boolean isCanceled;
  
  private Diagnostic blockedReason;
  
  public BasicMonitor()
  {
    super();
  }

  public boolean isCanceled()
  {
    return isCanceled;
  }

  public void setCanceled(boolean isCanceled)
  {
    this.isCanceled = isCanceled;
  }
  
  /**
   * Returns the current reason for task being blocked, or <code>null</code>.
   */
  public Diagnostic getBlockedReason()
  {
    return blockedReason;
  }
  
  public void setBlocked(Diagnostic reason)
  {
    this.blockedReason = reason;
  }

  public void clearBlocked()
  {
    this.blockedReason = null;
  }
 
  public void beginTask(String name, int totalWork)
  {
    // Do nothing.
  }
  
  public void setTaskName(String name)
  {
    // Do nothing.
  }

  public void subTask(String name)
  {
    // Do nothing.
  }

  public void worked(int work)
  {
    // Do nothing.
  }
  
  public void internalWorked(double work)
  {
    // Do nothing.
  }
    
  public void done()
  {
    // Do nothing.
  }
  
  /**
   * A simple monitor that delegates to another monitor.
   */
  public static class Delegating implements Monitor
  {
    protected Monitor monitor;
    
    public Delegating(Monitor monitor)
    {
      this.monitor = monitor; 
    }
    
    public boolean isCanceled()
    {
      return monitor.isCanceled();
    }

    public void setCanceled(boolean value)
    {
      monitor.setCanceled(value);
    }

    public void setBlocked(Diagnostic reason)
    {
      monitor.setBlocked(reason);
    }
    
    public void clearBlocked()
    {
      monitor.clearBlocked();
    }

    public void beginTask(String name, int totalWork)
    {
      monitor.beginTask(name, totalWork);
    }

    public void setTaskName(String name)
    {
      monitor.setTaskName(name);
    }

    public void subTask(String name)
    {
      monitor.subTask(name);
    }

    public void worked(int work)
    {
      monitor.worked(work);
    }
    
    public void internalWorked(double work)
    {
      monitor.internalWorked(work);
    }

    public void done()
    {
      monitor.done();
    }
    
    /**
     * A simple monitor that delegates to another monitor, and implements the Eclipse API
     */
    private static class Eclipse extends Delegating implements IProgressMonitorWithBlocking
    {
      public Eclipse(Monitor monitor)
      {
        super(monitor);
      }
      
      public void setBlocked(IStatus reason)
      {
        setBlocked
          (new BasicDiagnostic
              (reason.getSeverity(), 
               reason.getPlugin(), 
               reason.getCode(), 
               reason.getMessage(), 
               null));
      }
  
      public static IProgressMonitorWithBlocking createIProgressMonitorWithBlocking(Monitor monitor)
      {
        if (monitor instanceof IProgressMonitorWithBlocking)
        {
          return (IProgressMonitorWithBlocking)monitor;
        }
        else
        {
          return new Eclipse(monitor);
        }
      }
      
      public static IProgressMonitor createIProgressMonitor(Monitor monitor)
      {
        if (monitor instanceof IProgressMonitor)
        {
          return (IProgressMonitor)monitor;
        }
        else
        {
          return new Eclipse(monitor);
        }
      }
    }
  }
  
  /**
   * Creates a delegating wrapper that allows the monitor to be used 
   * in a context requiring an instance implementing the Eclipse API.
   */
  public static IProgressMonitor toIProgressMonitor(Monitor monitor)
  {
    return Delegating.Eclipse.createIProgressMonitor(monitor);
  }
  
  /**
   * Creates a delegating wrapper that allows the monitor to be used 
   * in a context requiring an instance implementing the Eclipse API.
   */
  public static IProgressMonitorWithBlocking toIProgressMonitorWithBlocking(Monitor monitor)
  {
    return Delegating.Eclipse.createIProgressMonitorWithBlocking(monitor);
  }
  
  /**
   * Create a progress monitor that consumes the specified number of ticks.
   * @since 2.13
   */
  public static IProgressMonitorWithBlocking subProgress(IProgressMonitor monitor, int ticks)
  {
    return new EclipseSubProgress(monitor, ticks);
  }
  
  /**
   * A simple monitor that delegates to another Eclipse monitor.
   */
  private static class EclipseDelegating implements Monitor
  {
    protected IProgressMonitor progressMonitor;
    protected IProgressMonitorWithBlocking progressMonitorWithBlocking;
    
    public EclipseDelegating(IProgressMonitor progressMonitor)
    {
      this.progressMonitor = progressMonitor; 
      if (progressMonitor instanceof IProgressMonitorWithBlocking)
      {
        this.progressMonitorWithBlocking = (IProgressMonitorWithBlocking)progressMonitor;
      }
    }
    
    public EclipseDelegating(IProgressMonitorWithBlocking progressMonitorWithBlocking)
    {
      this.progressMonitor = progressMonitorWithBlocking; 
      this.progressMonitorWithBlocking = progressMonitorWithBlocking; 
    }
    
    public boolean isCanceled()
    {
      return progressMonitor.isCanceled();
    }

    public void setCanceled(boolean value)
    {
      progressMonitor.setCanceled(value);
    }

    public void setBlocked(Diagnostic reason)
    {
      if (progressMonitorWithBlocking != null)
      {
        progressMonitorWithBlocking.setBlocked(BasicDiagnostic.toIStatus(reason));
      }
    }

    public void clearBlocked()
    {
      if (progressMonitorWithBlocking != null)
      {
        progressMonitorWithBlocking.clearBlocked();
      }
    }

    public void beginTask(String name, int totalWork)
    {
      progressMonitor.beginTask(name, totalWork);
    }
    
    public void setTaskName(String name)
    {
      progressMonitor.setTaskName(name);
    }

    public void subTask(String name)
    {
      progressMonitor.subTask(name);
    }

    public void worked(int work)
    {
      progressMonitor.worked(work);
    }
    
    public void internalWorked(double work)
    {
      progressMonitor.internalWorked(work);
    }

    public void done()
    {
      progressMonitor.done();
    }
  }
  
  /**
   * Creates a delegating wrapper that allows the Eclipse progress monitor to be used 
   * in a context requiring an instance implementing the monitor API.
   */
  public static Monitor toMonitor(IProgressMonitorWithBlocking progressMonitor)
  {
    return new EclipseDelegating(progressMonitor);
  }
  
  /**
   * Creates a delegating wrapper that allows the Eclipse progress monitor to be used 
   * in a context requiring an instance implementing the monitor API.
   */
  public static Monitor toMonitor(IProgressMonitor progressMonitor)
  {
    return new EclipseDelegating(progressMonitor);
  }
  
  /**
   * An Eclipse subprogress monitor that directly implements the monitor API.
   */
  @SuppressWarnings("deprecation")
  public static class EclipseSubProgress extends org.eclipse.core.runtime.SubProgressMonitor implements Monitor
  {
    public EclipseSubProgress(IProgressMonitor monitor, int ticks)
    {
      super(monitor, ticks);
    }

    public EclipseSubProgress(IProgressMonitor monitor, int ticks, int style)
    {
      super(monitor, ticks, style);
    }

    public void setBlocked(Diagnostic reason)
    {
      super.setBlocked(BasicDiagnostic.toIStatus(reason));
    }
  }
  
  /**
   * A simple monitor that prints progress to a print stream.
   */
  public static class Printing extends BasicMonitor
  {
    protected PrintStream printStream;

    public Printing(PrintStream printStream)
    {
      this.printStream = printStream;
    }

    @Override
    public void beginTask(String name, int totalWork)
    {
      if (name != null && name.length() != 0)
      {
        printStream.println(">>> " + name);
      }
    }

    @Override
    public void setTaskName(String name)
    {
      if (name != null && name.length() != 0)
      {
        printStream.println("<>> " + name);
      }
    }

    @Override
    public void subTask(String name)
    {
      if (name != null && name.length() != 0)
      {
        printStream.println(">>  " + name);
      }
    }
    
    @Override
    public void setBlocked(Diagnostic reason)
    {
      super.setBlocked(reason);
      printStream.println("#>  " + reason.getMessage());
    }
  
    @Override
    public void clearBlocked()
    {
      printStream.println("=>  " + getBlockedReason().getMessage());
      super.clearBlocked();
    }
  }
}

Back to the top