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

   1 /*
   2  * Reactor - Query.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 /**
  21  * A query is used to retrieve the current {@link State} of a system.
  22  *
  23  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  24  */
  25 public interface Query {
  26
  27         /**
  28          * Retrieves the current state of the system. The returned state is never
  29          * {@code null}.
  30          *
  31          * @return The current state of the system.
  32          */
  33         public State state();
  34
  35 }