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