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

   1 /*
   2  * Sone - CoreListener.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 java.util.EventListener;
  21
  22 import net.pterodactylus.sone.data.Image;
  23 import net.pterodactylus.sone.data.Sone;
  24 import net.pterodactylus.util.version.Version;
  25
  26 /**
  27  * Listener interface for objects that want to be notified on certain
  28  * {@link Core} events, such es discovery of new data.
  29  *
  30  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  31  */
  32 public interface CoreListener extends EventListener {
  33
  34         /**
  35          * Notifies a listener that a Sone was unlocked.
  36          *
  37          * @param sone
  38          *            The Sone that was unlocked
  39          */
  40         public void soneUnlocked(Sone sone);
  41
  42         /**
  43          * Notifies a listener that the insert of the given Sone has started.
  44          *
  45          * @see SoneInsertListener#insertStarted(Sone)
  46          * @param sone
  47          *            The Sone that is being inserted
  48          */
  49         public void soneInserting(Sone sone);
  50
  51         /**
  52          * Notifies a listener that the insert of the given Sone has finished
  53          * successfully.
  54          *
  55          * @see SoneInsertListener#insertFinished(Sone, long)
  56          * @param sone
  57          *            The Sone that has been inserted
  58          * @param insertDuration
  59          *            The insert duration (in milliseconds)
  60          */
  61         public void soneInserted(Sone sone, long insertDuration);
  62
  63         /**
  64          * Notifies a listener that the insert of the given Sone was aborted.
  65          *
  66          * @see SoneInsertListener#insertAborted(Sone, Throwable)
  67          * @param sone
  68          *            The Sone that was inserted
  69          * @param cause
  70          *            The cause for the abortion (may be {@code null})
  71          */
  72         public void soneInsertAborted(Sone sone, Throwable cause);
  73
  74         /**
  75          * Notifies a listener that a new version has been found.
  76          *
  77          * @param version
  78          *            The version that was found
  79          * @param releaseTime
  80          *            The release time of the new version
  81          * @param latestEdition
  82          *            The latest edition of the Sone homepage
  83          */
  84         public void updateFound(Version version, long releaseTime, long latestEdition);
  85
  86         /**
  87          * Notifies a listener that an image has started being inserted.
  88          *
  89          * @param image
  90          *            The image that is now inserted
  91          */
  92         public void imageInsertStarted(Image image);
  93
  94         /**
  95          * Notifies a listener that an image insert was aborted by the user.
  96          *
  97          * @param image
  98          *            The image that is not inserted anymore
  99          */
 100         public void imageInsertAborted(Image image);
 101
 102         /**
 103          * Notifies a listener that an image was successfully inserted.
 104          *
 105          * @param image
 106          *            The image that was inserted
 107          */
 108         public void imageInsertFinished(Image image);
 109
 110         /**
 111          * Notifies a listener that an image failed to be inserted.
 112          *
 113          * @param image
 114          *            The image that could not be inserted
 115          * @param cause
 116          *            The reason for the failed insert
 117          */
 118         public void imageInsertFailed(Image image, Throwable cause);
 119
 120 }