blob: 36532cf1250c3698828d9123f7b3adca09039524 (
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
|
/*
* Copyright (c) 2004 - 2012 Eike Stepper (Berlin, Germany) 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:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.net4j.util.om.monitor;
/**
* @author Eike Stepper
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface OMMonitor extends OMMonitorProgress
{
/**
* @since 2.0
*/
public static final int THOUSAND = 1000;
/**
* @since 2.0
*/
public static final double DEFAULT_TIME_FACTOR = THOUSAND;
/**
* @since 2.0
*/
public boolean isCanceled();
/**
* @since 2.0
*/
public void checkCanceled() throws MonitorCanceledException;
/**
* @since 2.0
*/
public boolean hasBegun() throws MonitorCanceledException;
/**
* @since 2.0
*/
public OMMonitor begin(double totalWork) throws MonitorCanceledException;
/**
* Same as calling <code>begin(ONE)</code>.
*
* @since 2.0
*/
public OMMonitor begin() throws MonitorCanceledException;
/**
* @since 2.0
*/
public void worked(double work) throws MonitorCanceledException;
/**
* Same as calling <code>worked(ONE)</code>.
*
* @since 2.0
*/
public void worked() throws MonitorCanceledException;
/**
* @since 2.0
*/
public OMMonitor fork(double work);
/**
* Same as calling <code>fork(ONE)</code>.
*
* @since 2.0
*/
public OMMonitor fork();
/**
* @since 2.0
*/
public Async forkAsync(double work);
/**
* Same as calling <code>forkAsync(ONE)</code>.
*
* @since 2.0
*/
public Async forkAsync();
/**
* @since 2.0
*/
public void done();
/**
* @author Eike Stepper
* @since 2.0
*/
public interface Async
{
public void stop();
}
}
|
