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