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

   1 /*
   2  * Sonitus - Controlled.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 import java.util.List;
  21
  22 /**
  23  * Interface for components that can be controlled externally in some way.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public interface Controlled {
  28
  29         /**
  30          * Returns the name of this controlled component.
  31          *
  32          * @return The name of this controlled component
  33          */
  34         public String name();
  35
  36         /**
  37          * Returns the controllers offered by this component.
  38          *
  39          * @return The controllers of this component
  40          */
  41         public List<Controller<?>> controllers();
  42
  43 }