src/main/java/net/pterodactylus/sone/core/CoreListenerManager.java

   1 /*
   2  * Sone - CoreListenerManager.java - Copyright © 2010–2012 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.sone.core;
  19
  20 import net.pterodactylus.sone.data.Image;
  21 import net.pterodactylus.sone.data.Sone;
  22 import net.pterodactylus.util.event.AbstractListenerManager;
  23 import net.pterodactylus.util.version.Version;
  24
  25 /**
  26  * Manager for {@link CoreListener}s.
  27  *
  28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  29  */
  30 public class CoreListenerManager extends AbstractListenerManager<Core, CoreListener> {
  31
  32         /**
  33          * Creates a new core listener manager.
  34          *
  35          * @param source
  36          *            The Core
  37          */
  38         public CoreListenerManager(Core source) {
  39                 super(source);
  40         }
  41
  42         //
  43         // ACTIONS
  44         //
  45
  46         /**
  47          * Notifies all listeners that the given Sone was unlocked.
  48          *
  49          * @see CoreListener#soneUnlocked(Sone)
  50          * @param sone
  51          *            The Sone that was unlocked
  52          */
  53         void fireSoneUnlocked(Sone sone) {
  54                 for (CoreListener coreListener : getListeners()) {
  55                         coreListener.soneUnlocked(sone);
  56                 }
  57         }
  58
  59         /**
  60          * Notifies all listeners that the insert of the given Sone has started.
  61          *
  62          * @see SoneInsertListener#insertStarted(Sone)
  63          * @param sone
  64          *            The Sone being inserted
  65          */
  66         void fireSoneInserting(Sone sone) {
  67                 for (CoreListener coreListener : getListeners()) {
  68                         coreListener.soneInserting(sone);
  69                 }
  70         }
  71
  72         /**
  73          * Notifies all listeners that the insert of the given Sone has finished
  74          * successfully.
  75          *
  76          * @see SoneInsertListener#insertFinished(Sone, long)
  77          * @param sone
  78          *            The Sone that was inserted
  79          * @param insertDuration
  80          *            The insert duration (in milliseconds)
  81          */
  82         void fireSoneInserted(Sone sone, long insertDuration) {
  83                 for (CoreListener coreListener : getListeners()) {
  84                         coreListener.soneInserted(sone, insertDuration);
  85                 }
  86         }
  87
  88         /**
  89          * Notifies all listeners that the insert of the given Sone was aborted.
  90          *
  91          * @see SoneInsertListener#insertStarted(Sone)
  92          * @param sone
  93          *            The Sone being inserted
  94          * @param cause
  95          *            The cause for the abortion (may be {@code null}
  96          */
  97         void fireSoneInsertAborted(Sone sone, Throwable cause) {
  98                 for (CoreListener coreListener : getListeners()) {
  99                         coreListener.soneInsertAborted(sone, cause);
 100                 }
 101         }
 102
 103         /**
 104          * Notifies all listeners that a new version was found.
 105          *
 106          * @see CoreListener#updateFound(Version, long, long)
 107          * @param version
 108          *            The new version
 109          * @param releaseTime
 110          *            The release time of the new version
 111          * @param latestEdition
 112          *            The latest edition of the Sone homepage
 113          */
 114         void fireUpdateFound(Version version, long releaseTime, long latestEdition) {
 115                 for (CoreListener coreListener : getListeners()) {
 116                         coreListener.updateFound(version, releaseTime, latestEdition);
 117                 }
 118         }
 119
 120         /**
 121          * Notifies all listeners that an image has started being inserted.
 122          *
 123          * @see CoreListener#imageInsertStarted(Image)
 124          * @param image
 125          *            The image that is now inserted
 126          */
 127         void fireImageInsertStarted(Image image) {
 128                 for (CoreListener coreListener : getListeners()) {
 129                         coreListener.imageInsertStarted(image);
 130                 }
 131         }
 132
 133         /**
 134          * Notifies all listeners that an image insert was aborted by the user.
 135          *
 136          * @see CoreListener#imageInsertAborted(Image)
 137          * @param image
 138          *            The image that is not inserted anymore
 139          */
 140         void fireImageInsertAborted(Image image) {
 141                 for (CoreListener coreListener : getListeners()) {
 142                         coreListener.imageInsertAborted(image);
 143                 }
 144         }
 145
 146         /**
 147          * Notifies all listeners that an image was successfully inserted.
 148          *
 149          * @see CoreListener#imageInsertFinished(Image)
 150          * @param image
 151          *            The image that was inserted
 152          */
 153         void fireImageInsertFinished(Image image) {
 154                 for (CoreListener coreListener : getListeners()) {
 155                         coreListener.imageInsertFinished(image);
 156                 }
 157         }
 158
 159         /**
 160          * Notifies all listeners that an image failed to be inserted.
 161          *
 162          * @see CoreListener#imageInsertFailed(Image, Throwable)
 163          * @param image
 164          *            The image that could not be inserted
 165          * @param cause
 166          *            The cause of the failure
 167          */
 168         void fireImageInsertFailed(Image image, Throwable cause) {
 169                 for (CoreListener coreListener : getListeners()) {
 170                         coreListener.imageInsertFailed(image, cause);
 171                 }
 172         }
 173
 174 }