src/main/java/net/pterodactylus/sonitus/data/ControlledComponent.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 ControlledComponent {
  28
  29         /**
  30          * Adds the given listener to the list of registered listeners.
  31          *
  32          * @param metadataListener
  33          *              The metadata listener to add
  34          */
  35         void addMetadataListener(MetadataListener metadataListener);
  36
  37         /**
  38          * Removes the given listener from the list of registered listeners.
  39          *
  40          * @param metadataListener
  41          *              The metadata listener to remove
  42          */
  43         void removeMetadataListener(MetadataListener metadataListener);
  44
  45         /**
  46          * Returns the name of this controlled component.
  47          *
  48          * @return The name of this controlled component
  49          */
  50         public String name();
  51
  52         /**
  53          * Returns the current metadata of this component.
  54          *
  55          * @return The current metadata of this component
  56          */
  57         public Metadata metadata();
  58
  59         /**
  60          * Returns the controllers offered by this component.
  61          *
  62          * @return The controllers of this component
  63          */
  64         public List<Controller<?>> controllers();
  65
  66 }