src/main/java/net/pterodactylus/reactor/Trigger.java

   1 /*
   2  * Reactor - 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.reactor;
  19
  20 import net.pterodactylus.reactor.states.FileState;
  21
  22 /**
  23  * A trigger determines whether two different states actually warrant a change
  24  * trigger. For example, two {@link FileState}s might contain different file
  25  * sizes but a trigger might only care about whether the file appeared or
  26  * disappeared since the last check.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public interface Trigger {
  31
  32         /**
  33          * Checks whether the given states warrant a change trigger.
  34          *
  35          * @param currentState
  36          *            The current state of a system
  37          * @param previousState
  38          *            The previous state of the system
  39          * @return {@code true} if the given states warrant a change trigger,
  40          *         {@code false} otherwise
  41          */
  42         boolean triggers(State currentState, State previousState);
  43
  44         /**
  45          * Returns the object (or objects) that triggered a change. This method will
  46          * only return a meaningful value when {@link #triggers(State, State)}
  47          * returns {@code true}.
  48          *
  49          * @return The object that triggered a change
  50          */
  51         Object trigger();
  52
  53 }