Add Sinfest comic parser.
[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / Trigger.java
1 /*
2  * Rhynodge - Trigger.java - Copyright © 2013 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.rhynodge;
19
20 import net.pterodactylus.rhynodge.output.Output;
21 import net.pterodactylus.rhynodge.states.FileState;
22
23 /**
24  * A trigger determines whether two different states actually warrant a change
25  * trigger. For example, two {@link FileState}s might contain different file
26  * sizes but a trigger might only care about whether the file appeared or
27  * disappeared since the last check.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public interface Trigger {
32
33         /**
34          * Merges the current state into the previous state, returning the merged
35          * state.
36          *
37          * @param previousState
38          *            The previous state of the system
39          * @param currentState
40          *            The current state of a system
41          * @return The new state, containing a meaningful merge between the previous
42          *         and the current state
43          */
44         State mergeStates(State previousState, State currentState);
45
46         /**
47          * Checks whether the states given to {@link #mergeStates(State, State)}
48          * warrant a change trigger.
49          *
50          * @return {@code true} if the states given to
51          *         {@link #mergeStates(State, State)} warrant a change trigger,
52          *         {@code false} otherwise
53          */
54         boolean triggers();
55
56         /**
57          * Returns the output of this trigger. This will only return a meaningful
58          * value if {@link #triggers()} returns {@code true}.
59          *
60          * @param reaction
61          *            The reaction being triggered
62          * @return The output of this trigger
63          */
64         Output output(Reaction reaction);
65
66 }