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.util.version.Version;
  24
  25 /**
  26  * Listener interface for objects that want to be notified on certain
  27  * {@link Core} events, such es discovery of new data.
  28  *
  29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  30  */
  31 public interface CoreListener extends EventListener {
  32
  33         /**
  34          * Notifies a listener that a new version has been found.
  35          *
  36          * @param version
  37          *            The version that was found
  38          * @param releaseTime
  39          *            The release time of the new version
  40          * @param latestEdition
  41          *            The latest edition of the Sone homepage
  42          */
  43         public void updateFound(Version version, long releaseTime, long latestEdition);
  44
  45         /**
  46          * Notifies a listener that an image has started being inserted.
  47          *
  48          * @param image
  49          *            The image that is now inserted
  50          */
  51         public void imageInsertStarted(Image image);
  52
  53         /**
  54          * Notifies a listener that an image insert was aborted by the user.
  55          *
  56          * @param image
  57          *            The image that is not inserted anymore
  58          */
  59         public void imageInsertAborted(Image image);
  60
  61         /**
  62          * Notifies a listener that an image was successfully inserted.
  63          *
  64          * @param image
  65          *            The image that was inserted
  66          */
  67         public void imageInsertFinished(Image image);
  68
  69         /**
  70          * Notifies a listener that an image failed to be inserted.
  71          *
  72          * @param image
  73          *            The image that could not be inserted
  74          * @param cause
  75          *            The reason for the failed insert
  76          */
  77         public void imageInsertFailed(Image image, Throwable cause);
  78
  79 }