src/main/java/net/pterodactylus/sonitus/data/Controller.java

   1 /*
   2  * Sonitus - Controller.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.sonitus.data;
  19
  20 /**
  21  * A single controllable element.
  22  *
  23  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  24  */
  25 public interface Controller<V extends Comparable<V>> {
  26
  27         /**
  28          * Returns the minimum value of this controller.
  29          *
  30          * @return The minimum value of this controller
  31          */
  32         V minimum();
  33
  34         /**
  35          * Returns the maximum value of this controller.
  36          *
  37          * @return The maximum value of this controller
  38          */
  39         V maximum();
  40
  41         /**
  42          * Returns whether this control has a “center” position.
  43          *
  44          * @return {@code true} if this controller has a “center” position, {@code
  45          *         false} otherwise
  46          */
  47         boolean centered();
  48
  49         /**
  50          * Returns the current value of this controller.
  51          *
  52          * @return The current value of this controller
  53          */
  54         V value();
  55
  56         /**
  57          * Sets the current value of this controller.
  58          *
  59          * @param value
  60          *              The current value of this controller
  61          */
  62         void value(V value);
  63
  64 }