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