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 the insert of the given Sone has finished
  36          * successfully.
  37          *
  38          * @see SoneInsertListener#insertFinished(Sone, long)
  39          * @param sone
  40          *            The Sone that has been inserted
  41          * @param insertDuration
  42          *            The insert duration (in milliseconds)
  43          */
  44         public void soneInserted(Sone sone, long insertDuration);
  45
  46         /**
  47          * Notifies a listener that the insert of the given Sone was aborted.
  48          *
  49          * @see SoneInsertListener#insertAborted(Sone, Throwable)
  50          * @param sone
  51          *            The Sone that was inserted
  52          * @param cause
  53          *            The cause for the abortion (may be {@code null})
  54          */
  55         public void soneInsertAborted(Sone sone, Throwable cause);
  56
  57         /**
  58          * Notifies a listener that a new version has been found.
  59          *
  60          * @param version
  61          *            The version that was found
  62          * @param releaseTime
  63          *            The release time of the new version
  64          * @param latestEdition
  65          *            The latest edition of the Sone homepage
  66          */
  67         public void updateFound(Version version, long releaseTime, long latestEdition);
  68
  69         /**
  70          * Notifies a listener that an image has started being inserted.
  71          *
  72          * @param image
  73          *            The image that is now inserted
  74          */
  75         public void imageInsertStarted(Image image);
  76
  77         /**
  78          * Notifies a listener that an image insert was aborted by the user.
  79          *
  80          * @param image
  81          *            The image that is not inserted anymore
  82          */
  83         public void imageInsertAborted(Image image);
  84
  85         /**
  86          * Notifies a listener that an image was successfully inserted.
  87          *
  88          * @param image
  89          *            The image that was inserted
  90          */
  91         public void imageInsertFinished(Image image);
  92
  93         /**
  94          * Notifies a listener that an image failed to be inserted.
  95          *
  96          * @param image
  97          *            The image that could not be inserted
  98          * @param cause
  99          *            The reason for the failed insert
 100          */
 101         public void imageInsertFailed(Image image, Throwable cause);
 102
 103 }