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

   1 /*
   2  * Sonitus - AbstractControlledComponent.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 import com.google.common.collect.Lists;
  23
  24 /**
  25  * Abstract {@link ControlledComponent} implementation that takes care of
  26  * managing {@link MetadataListener}s.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public abstract class AbstractControlledComponent implements ControlledComponent {
  31
  32         /** The list of metadata listeners. */
  33         private final List<MetadataListener> metadataListeners = Lists.newArrayList();
  34
  35         //
  36         // LISTENER MANAGEMENT
  37         //
  38
  39         @Override
  40         public void addMetadataListener(MetadataListener metadataListener) {
  41                 metadataListeners.add(metadataListener);
  42         }
  43
  44         @Override
  45         public void removeMetadataListener(MetadataListener metadataListener) {
  46                 metadataListeners.remove(metadataListener);
  47         }
  48
  49         //
  50         // EVENT METHODS
  51         //
  52
  53         /**
  54          * Notifies all registered metadata listeners that the metadata has changed.
  55          *
  56          * @param metadata
  57          *              The new metadata
  58          */
  59         protected void fireMetadataUpdated(Metadata metadata) {
  60                 for (MetadataListener metadataListener : metadataListeners) {
  61                         metadataListener.metadataUpdated(this, metadata);
  62                 }
  63         }
  64
  65 }