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
|
/*
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.common.utils.time;
import lombok.AccessLevel;
import lombok.Getter;
import org.onap.policy.common.utils.time.TestTime;
/**
* Work item to be executed at some time.
*/
class WorkItem {
/**
* Pseudo time with which this item is associated.
*/
private final TestTime currentTime;
/**
* Time, in milliseconds, when the timer should fire next.
*/
@Getter(AccessLevel.PROTECTED)
private long nextMs;
/**
* Constructs the object.
*
* @param currentTime time with which this item is associated
* @param delayMs time, in milliseconds, before this item should be executed
*/
public WorkItem(TestTime currentTime, long delayMs) {
if (delayMs < 0) {
throw new IllegalArgumentException("invalid delay " + delayMs);
}
this.currentTime = currentTime;
bumpNextTime(delayMs);
}
/**
* Gets the delay until the item should be fired.
*
* @return the delay until the item should be fired
*/
public long getDelay() {
return (nextMs - currentTime.getMillis());
}
/**
* Determines if this work item was canceled.
*
* @return {@code true} if this item was canceled, {@code false} otherwise
*/
public boolean wasCancelled() {
return false;
}
/**
* Bumps {@link #nextMs}, if this is a periodic task. The default method simply
* returns {@code false}.
*
* @return {@code true} if the time was bumped, {@code false} otherwise (i.e., it is
* not a periodic task)
*/
public boolean bumpNextTime() {
return false;
}
/**
* Bumps {@link #nextMs}, setting it to the current time plus the given delay.
*
* @param delayMs time, in milliseconds, before this item should be (re-)executed
*/
protected void bumpNextTime(long delayMs) {
if (delayMs < 0) {
throw new IllegalArgumentException("negative delay");
}
// always bump by at least 1 millisecond
this.nextMs = currentTime.getMillis() + Math.max(1, delayMs);
}
/**
* Interrupts the thread that created the work item, if appropriate. The default
* method does nothing.
*/
public void interrupt() {
// do nothing
}
/**
* Determines if this item is associated with the given object. The default method
* simply returns {@code false}.
*
* @param associate candidate associate (e.g., Timer)
* @return {@code true} if the item is associated with the given object, {@code false}
* otherwise
*/
public boolean isAssociatedWith(Object associate) {
return false;
}
/**
* Fires/executes this item. The default method does nothing.
*/
public void fire() {
// do nothing
}
}
|
