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

   1 /*
   2  * Sone - CoreListener.java - Copyright © 2010 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.Post;
  24 import net.pterodactylus.sone.data.PostReply;
  25 import net.pterodactylus.sone.data.Sone;
  26 import net.pterodactylus.util.version.Version;
  27
  28 /**
  29  * Listener interface for objects that want to be notified on certain
  30  * {@link Core} events, such es discovery of new data.
  31  *
  32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  33  */
  34 public interface CoreListener extends EventListener {
  35
  36         /**
  37          * Notifies a listener that a new Sone has been discovered.
  38          *
  39          * @param sone
  40          *            The new Sone
  41          */
  42         public void newSoneFound(Sone sone);
  43
  44         /**
  45          * Notifies a listener that a new post has been found.
  46          *
  47          * @param post
  48          *            The new post
  49          */
  50         public void newPostFound(Post post);
  51
  52         /**
  53          * Notifies a listener that a new reply has been found.
  54          *
  55          * @param reply
  56          *            The new reply
  57          */
  58         public void newReplyFound(PostReply reply);
  59
  60         /**
  61          * Notifies a listener that the given Sone is now marked as known.
  62          *
  63          * @param sone
  64          *            The known Sone
  65          */
  66         public void markSoneKnown(Sone sone);
  67
  68         /**
  69          * Notifies a listener that the given post is now marked as known.
  70          *
  71          * @param post
  72          *            The known post
  73          */
  74         public void markPostKnown(Post post);
  75
  76         /**
  77          * Notifies a listener that the given reply is now marked as known.
  78          *
  79          * @param reply
  80          *            The known reply
  81          */
  82         public void markReplyKnown(PostReply reply);
  83
  84         /**
  85          * Notifies a listener that the given Sone was removed.
  86          *
  87          * @param sone
  88          *            The removed Sone
  89          */
  90         public void soneRemoved(Sone sone);
  91
  92         /**
  93          * Notifies a listener that the given post was removed.
  94          *
  95          * @param post
  96          *            The removed post
  97          */
  98         public void postRemoved(Post post);
  99
 100         /**
 101          * Notifies a listener that the given reply was removed.
 102          *
 103          * @param reply
 104          *            The removed reply
 105          */
 106         public void replyRemoved(PostReply reply);
 107
 108         /**
 109          * Notifies a listener when a Sone was locked.
 110          *
 111          * @param sone
 112          *            The Sone that was locked
 113          */
 114         public void soneLocked(Sone sone);
 115
 116         /**
 117          * Notifies a listener that a Sone was unlocked.
 118          *
 119          * @param sone
 120          *            The Sone that was unlocked
 121          */
 122         public void soneUnlocked(Sone sone);
 123
 124         /**
 125          * Notifies a listener that the insert of the given Sone has started.
 126          *
 127          * @see SoneInsertListener#insertStarted(Sone)
 128          * @param sone
 129          *            The Sone that is being inserted
 130          */
 131         public void soneInserting(Sone sone);
 132
 133         /**
 134          * Notifies a listener that the insert of the given Sone has finished
 135          * successfully.
 136          *
 137          * @see SoneInsertListener#insertFinished(Sone, long)
 138          * @param sone
 139          *            The Sone that has been inserted
 140          * @param insertDuration
 141          *            The insert duration (in milliseconds)
 142          */
 143         public void soneInserted(Sone sone, long insertDuration);
 144
 145         /**
 146          * Notifies a listener that the insert of the given Sone was aborted.
 147          *
 148          * @see SoneInsertListener#insertAborted(Sone, Throwable)
 149          * @param sone
 150          *            The Sone that was inserted
 151          * @param cause
 152          *            The cause for the abortion (may be {@code null})
 153          */
 154         public void soneInsertAborted(Sone sone, Throwable cause);
 155
 156         /**
 157          * Notifies a listener that a new version has been found.
 158          *
 159          * @param version
 160          *            The version that was found
 161          * @param releaseTime
 162          *            The release time of the new version
 163          * @param latestEdition
 164          *            The latest edition of the Sone homepage
 165          */
 166         public void updateFound(Version version, long releaseTime, long latestEdition);
 167
 168         /**
 169          * Notifies a listener that an image has started being inserted.
 170          *
 171          * @param image
 172          *            The image that is now inserted
 173          */
 174         public void imageInsertStarted(Image image);
 175
 176         /**
 177          * Notifies a listener that an image insert was aborted by the user.
 178          *
 179          * @param image
 180          *            The image that is not inserted anymore
 181          */
 182         public void imageInsertAborted(Image image);
 183
 184         /**
 185          * Notifies a listener that an image was successfully inserted.
 186          *
 187          * @param image
 188          *            The image that was inserted
 189          */
 190         public void imageInsertFinished(Image image);
 191
 192         /**
 193          * Notifies a listener that an image failed to be inserted.
 194          *
 195          * @param image
 196          *            The image that could not be inserted
 197          * @param cause
 198          *            The reason for the failed insert
 199          */
 200         public void imageInsertFailed(Image image, Throwable cause);
 201
 202 }