Repository navigation
Expand file tree
/
Copy pathSequenceManager.java
More file actions
357 lines (279 loc) · 12.9 KB
/
Copy pathSequenceManager.java
File metadata and controls
357 lines (279 loc) · 12.9 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
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
package com.abilityapi.sequenceapi;
import com.abilityapi.sequenceapi.util.Ordered;
import com.abilityapi.sequenceapi.util.Tristate;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Multimap;
import java.util.UUID;
import java.util.function.Predicate;
import static com.abilityapi.sequenceapi.SequencePreconditions.checkContextNotNull;
import static com.google.common.base.Preconditions.checkNotNull;
/**
* Represents a way to manage the life cycle of
* an {@link Sequence} provided by the {@link SequenceRegistry}
* as a {@link SequenceBlueprint}.
*
* @param <T> the event type
*/
public class SequenceManager<T> {
private final SequenceRegistry<T> sequenceRegistry;
private final Multimap<UUID, Sequence<T>> sequences = HashMultimap.create();
private final Multimap<UUID, Ordered<Class<? extends T>>> blockedSequences = HashMultimap.create();
private long blockOrderIndex = 0;
public SequenceManager(final SequenceRegistry<T> sequenceRegistry) {
this.sequenceRegistry = sequenceRegistry;
}
/**
* Invokes the observer check with the provided event
* and {@link SequenceContext}.
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#ID} to provide ownership over
* a running {@link Sequence}.</p>
*
* @param event the event
* @param sequenceContext the sequence context
*/
public void invokeObserver(final T event, final SequenceContext sequenceContext) {
checkNotNull(event);
checkNotNull(sequenceContext);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.ID, UUID.class);
this.sequences.get(sequenceContext.getId()).removeIf(sequence -> {
for (Ordered<Class<? extends T>> block : this.blockedSequences.get(sequenceContext.getId())) {
if (block.getElement().equals(sequence.getTriggerClass())) return true;
}
return this._invokeObserver(event, sequence, sequenceContext);
});
// Creates a new sequence from a blueprint.
this._createBlueprints(event, sequenceContext);
}
/**
* Invokes the observer check with the provided event
* and {@link SequenceContext} if the predicate returns true.
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#ID} to provide ownership over
* a running {@link Sequence}.</p>
*
* @param event the event
* @param sequenceContext the sequence context
* @param predicate the predicate
*/
public void invokeObserverIf(final T event, final SequenceContext sequenceContext, final Predicate<Object> predicate) {
checkNotNull(event);
checkNotNull(sequenceContext);
checkNotNull(predicate);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.ID, UUID.class);
this.sequences.get(sequenceContext.getId()).removeIf(sequence -> {
for (Ordered<Class<? extends T>> block : this.blockedSequences.get(sequenceContext.getId())) {
if (block.getElement().equals(sequence.getTriggerClass())) return true;
}
if (!predicate.test(sequence)) return false;
return this._invokeObserver(event, sequence, sequenceContext);
});
// Creates a new sequence from a blueprint.
this._createBlueprints(event, sequenceContext);
}
/**
* Invokes the scheduler update with the provided
* {@link SequenceContext}.
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#ID} to provide ownership over
* a running {@link Sequence}.</p>
*
* @param sequenceContext the sequence context
*/
public void updateScheduler(final SequenceContext sequenceContext) {
checkNotNull(sequenceContext);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.ID, UUID.class);
this.sequences.get(sequenceContext.getId()).removeIf(sequence -> {
for (Ordered<Class<? extends T>> block : this.blockedSequences.get(sequenceContext.getId())) {
if (block.getElement().equals(sequence.getTriggerClass())) return true;
}
return this._invokeScheduler(sequence, sequenceContext) || this._invokeAfter(sequence, sequenceContext);
});
}
/**
* Invokes the scheduler update with the provided
* {@link SequenceContext} if the predicate returns true.
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#ID} to provide ownership over
* a running {@link Sequence}.</p>
*
* @param sequenceContext the sequence context
* @param predicate the predicate
*/
public void updateSchedulerIf(final SequenceContext sequenceContext, final Predicate<Sequence<T>> predicate) {
checkNotNull(sequenceContext);
checkNotNull(predicate);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.ID, UUID.class);
this.sequences.get(sequenceContext.getId()).removeIf(sequence -> {
for (Ordered<Class<? extends T>> block : this.blockedSequences.get(sequenceContext.getId())) {
if (block.getElement().equals(sequence.getTriggerClass())) return true;
}
if (!predicate.test(sequence)) return false;
return this._invokeScheduler(sequence, sequenceContext) || this._invokeAfter(sequence, sequenceContext);
});
}
/**
* Adds the trigger class from the {@link SequenceContext} root
* to the block list, which is removed on the next invocation.
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#OWNER} to provide ownership over
* a running {@link Sequence}.
*
* It must also contain a {@link SequenceContext#ROOT} that
* is an event class trigger of {@link T} to filter.</p>
*
* @param sequenceContext the sequence context
* @return the block id
*/
public long block(final SequenceContext sequenceContext) {
checkNotNull(sequenceContext);
checkContextNotNull(sequenceContext, SequenceContext.ROOT);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.OWNER, UUID.class);
final long index = this.blockOrderIndex++;
if (this.blockedSequences.containsEntry(sequenceContext.getOwner(), new Ordered<>(index, sequenceContext.getRoot()))) return index;
this.blockedSequences.put(sequenceContext.getOwner(), new Ordered<>(index, sequenceContext.getRoot()));
return index;
}
/**
* Removes the trigger class found in the
* {@link SequenceContext} root in the block list.
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#OWNER} to provide ownership over
* a running {@link Sequence}.
*
* It will also look for a {@link SequenceContext#ID} to
* provide the order index.
*
* It must also contain a {@link SequenceContext#ROOT} that
* is an event class trigger of {@link T} to filter.</p>
*
* @param sequenceContext the sequence context
*/
public void unblock(final SequenceContext sequenceContext) {
checkNotNull(sequenceContext);
checkContextNotNull(sequenceContext, SequenceContext.ROOT);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.ID, Long.class);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.OWNER, UUID.class);
if (!this.blockedSequences.containsEntry(sequenceContext.getOwner(), new Ordered<>(sequenceContext.getId(), sequenceContext.getRoot()))) return;
this.blockedSequences.remove(sequenceContext.getOwner(), new Ordered<>(sequenceContext.getId(), sequenceContext.getRoot()));
}
/**
* Removes all the {@link Sequence} from the running
* list if it has expired or cancelled.
*
* <p>If force is set to true, it will remove all of the
* running sequences regardless whether it has been
* cancelled or expired.</p>
*
* @param force false to remove safely, true to remove with force
*/
public void clean(boolean force) {
ImmutableSet.copyOf(this.sequences.keySet()).forEach(uuid -> this.clean(SequenceContext.builder().id(uuid).build(), force));
}
/**
* Removes a specific {@link Sequence} from the running
* list if it has expired or cancelled.
*
* <p>If force is set to true, it will remove all of the
* running sequences regardless whether it has been
* cancelled or expired.</p>
*
* <p>The {@link SequenceContext} must contain a unique
* {@link SequenceContext#ID} to provide ownership over
* a running {@link Sequence}.</p>
*
* @param sequenceContext the sequence context
* @param force false to remove safely, true to remove with force
*/
public void clean(final SequenceContext sequenceContext, boolean force) {
checkNotNull(sequenceContext);
SequencePreconditions.checkContextType(sequenceContext, SequenceContext.ID, UUID.class);
this.sequences.get(sequenceContext.getId()).removeIf(sequence -> {
if (sequence.getState().equals(Sequence.State.FINISHED)) return force;
return force || sequence.getState().equals(Sequence.State.EXPIRED);
});
}
public boolean _invokeObserver(final T event, final Sequence<T> sequence, final SequenceContext sequenceContext) {
boolean remove = false;
// 1. Apply the sequence.
sequence.applyObserve(event, sequenceContext);
// 2. Check if the sequence is cancelled, or is expired.
final Sequence.State sequenceState = sequence.getState();
// Check for an updated state first.
sequenceState.update(sequence);
if (!sequenceState.isSafe()) {
remove = true;
}
// 3. Check if the sequence has finished and fire the hook and remove.
if (sequenceState.equals(Sequence.State.FINISHED)) {
// Fire sequence finish hook.
remove = true;
}
return remove;
}
public boolean _invokeAfter(final Sequence<T> sequence, final SequenceContext sequenceContext) {
boolean remove;
// 1. Apply the sequence, this has one chance to pass, so if it fails it can be removed.
remove = sequence.applyAfter(sequenceContext).equals(Tristate.FALSE);
// 2. Check if the sequence is cancelled, or is expired.
final Sequence.State sequenceState = sequence.getState();
// Check for an updated state first.
sequenceState.update(sequence);
if (!sequenceState.isSafe()) {
remove = true;
}
// 3. Check if the sequence has finished and fire the hook and remove.
if (sequenceState.equals(Sequence.State.FINISHED)) {
// Fire sequence finish hook.
remove = true;
}
return remove;
}
public boolean _invokeScheduler(final Sequence<T> sequence, final SequenceContext sequenceContext) {
boolean remove = false;
// 1. Apply the sequence.
sequence.applySchedule(sequenceContext);
// 2. Check if the sequence is cancelled, or is expired.
final Sequence.State sequenceState = sequence.getState();
// Check for an updated state first.
sequenceState.update(sequence);
if (!sequenceState.isSafe()) {
remove = true;
}
// 3. Check if the sequence has finished and fire the hook and remove.
if (sequenceState.equals(Sequence.State.FINISHED)) {
// Fire sequence finish hook.
remove = true;
}
return remove;
}
public void _createBlueprints(final T event, final SequenceContext sequenceContext) {
for (SequenceBlueprint<T> sequenceBlueprint : this.sequenceRegistry) {
// 1. Check for matching sequence.
if (this.sequences.get(sequenceContext.getId()).stream()
.anyMatch(playerSequence -> playerSequence.getBlueprint()
.equals(sequenceBlueprint))) continue;
// 2. Apply the sequence for the first time to check the observer or leave it.
final Sequence<T> sequence = sequenceBlueprint.create(event, sequenceContext);
if (sequence.applyObserve(event, sequenceContext)) {
// Check for an updated state first.
sequence.getState().update(sequence);
if (!sequence.getState().isSafe()) {
continue;
}
if (sequence.getState().equals(Sequence.State.FINISHED)) {
// Fire sequence finish hook.
continue;
}
this.sequences.put(sequenceContext.getId(), sequence);
}
}
}
}