forked from actframework/actframework
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathProgressGauge.java
More file actions
90 lines (78 loc) · 1.92 KB
/
ProgressGauge.java
File metadata and controls
90 lines (78 loc) · 1.92 KB
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
package act.util;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
/**
* Class implement this interface can track progress
*/
public interface ProgressGauge {
/**
* Set ID to the gauge
*
* @param id
* the gauge ID
*/
void setId(String id);
/**
* Update max hint. If the number is negative, then
* it indicate the progress is indefinite
*
* @param maxHint the max steps hint
*/
void updateMaxHint(int maxHint);
/**
* Advances the progress by one step
*/
void step();
/**
* Advances the progress by specified steps
* @param steps the step size
*/
void stepBy(int steps);
/**
* Log progress
*
* @param steps the new progress value
*/
void stepTo(int steps);
/**
* Report the current progress steps
*
* @return the current progress
*/
int currentSteps();
/**
* Returns the max hint
*
* @return the max hint setting
*/
int maxHint();
/**
* Mark the progress has been finished
*/
boolean done();
/**
* Add an listener to this gauge that monitors the progress update
* @param listener the listener
*/
void addListener(Listener listener);
interface Listener {
void onUpdate(ProgressGauge progressGauge);
}
}