forked from strongback/strongback-java
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SwitchReactor.java
96 lines (86 loc) · 3.88 KB
/
SwitchReactor.java
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
/*
* Strongback
* Copyright 2015, Strongback and individual contributors by the @authors tag.
* See the COPYRIGHT.txt in the distribution for a full listing of individual
* contributors.
*
* Licensed under the MIT License; you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://opensource.org/licenses/MIT
* 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.
*/
package org.strongback;
import java.util.function.Supplier;
import org.strongback.annotation.ThreadSafe;
import org.strongback.command.Command;
import org.strongback.components.Switch;
/**
* A class that allows other components to react to the state of switches. For example, the reactor can be used to submit a
* command whenever a Gamepad's left trigger button is pressed and submit a different command when the same trigger is released:
*
* <pre>
* Gamepad gamepad = ...
* reactor.onTriggered(gamepad.getRightTrigger(),()->Strongback.submit(new FireRepeatedlyCommand()));
* reactor.onUnTriggered(gamepad.getRightTrigger(),()->Strongback.submit(new StopFireCommand()));
* </pre>
* <p>
* The reactor is threadsafe, meaning functions can be registered even while the reactor is forwarding state and state
* transitions to the already-registered functions.
* <p>
* It is not currently possible to remove a function once it has been registered.
*/
@ThreadSafe
public interface SwitchReactor {
/**
* Submit a {@link Command} the moment when the specified {@link Switch} is triggered.
*
* @param swtch the {@link Switch}
* @param commandSupplier the supplier of the command to submit; may not be null but may return a null command
*/
default public void onTriggeredSubmit(Switch swtch, Supplier<Command> commandSupplier) {
onTriggered(swtch,()->Strongback.submit(commandSupplier.get()));
}
/**
* Submit a {@link Command} the moment when the specified {@link Switch} is untriggered.
*
* @param swtch the {@link Switch}
* @param commandSupplier the supplier of the command to submit; may not be null but may return a null command
*/
default public void onUntriggeredSubmit(Switch swtch, Supplier<Command> commandSupplier) {
onUntriggered(swtch,()->Strongback.submit(commandSupplier.get()));
}
/**
* Register a {@link Runnable} function that is to be called the moment when the specified {@link Switch} is triggered.
*
* @param swtch the {@link Switch}
* @param function the function to execute when the switch is triggered
*/
public void onTriggered(Switch swtch, Runnable function);
/**
* Register a {@link Runnable} function that is to be called the moment when the specified {@link Switch} is untriggered.
*
* @param swtch the {@link Switch}
* @param function the function to execute when the switch is untriggered
*/
public void onUntriggered(Switch swtch, Runnable function);
/**
* Register a {@link Runnable} function to be called repeatedly whenever the specified {@link Switch} is in the triggered
* state.
*
* @param swtch the {@link Switch}
* @param function the function to execute while the switch remains triggered
*/
public void whileTriggered(Switch swtch, Runnable function);
/**
* Register a {@link Runnable} function to be called repeatedly whenever the specified {@link Switch} is not in the
* triggered state.
*
* @param swtch the {@link Switch}
* @param function the function to execute while the switch remains untriggered
*/
public void whileUntriggered(Switch swtch, Runnable function);
}