Rename project to “Rhynodge.”

[rhynodge.git] / src / main / java / net / pterodactylus / rhynodge / Trigger.java

diff --git a/src/main/java/net/pterodactylus/rhynodge/Trigger.java b/src/main/java/net/pterodactylus/rhynodge/Trigger.java
new file mode 100644 (file)
index 0000000..3b5a730
--- /dev/null
+++ b/src/main/java/net/pterodactylus/rhynodge/Trigger.java
@@ -0,0 +1,55 @@
+/*
+ * Rhynodge - Trigger.java - Copyright © 2013 David Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.rhynodge;
+
+import net.pterodactylus.rhynodge.output.Output;
+import net.pterodactylus.rhynodge.states.FileState;
+
+/**
+ * A trigger determines whether two different states actually warrant a change
+ * trigger. For example, two {@link FileState}s might contain different file
+ * sizes but a trigger might only care about whether the file appeared or
+ * disappeared since the last check.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public interface Trigger {
+
+       /**
+        * Checks whether the given states warrant a change trigger.
+        *
+        * @param currentState
+        *            The current state of a system
+        * @param previousState
+        *            The previous state of the system
+        * @return {@code true} if the given states warrant a change trigger,
+        *         {@code false} otherwise
+        */
+       boolean triggers(State currentState, State previousState);
+
+       /**
+        * Returns the output of this trigger. This will only return a meaningful
+        * value if {@link #triggers(State, State)} returns {@code true}.
+        *
+        * @param reaction
+        *            The reaction being triggered
+        * @return The output of this trigger
+        */
+       Output output(Reaction reaction);
+
+}