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.Post;
  23 import net.pterodactylus.sone.data.Reply;
  24 import net.pterodactylus.sone.data.Sone;
  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 a Sone is now being rescued.
  36          *
  37          * @param sone
  38          *            The Sone that is rescued
  39          */
  40         public void rescuingSone(Sone sone);
  41
  42         /**
  43          * Notifies a listener that the Sone was rescued and can now be unlocked.
  44          *
  45          * @param sone
  46          *            The Sone that was rescued
  47          */
  48         public void rescuedSone(Sone sone);
  49
  50         /**
  51          * Notifies a listener that a new Sone has been discovered.
  52          *
  53          * @param sone
  54          *            The new Sone
  55          */
  56         public void newSoneFound(Sone sone);
  57
  58         /**
  59          * Notifies a listener that a new post has been found.
  60          *
  61          * @param post
  62          *            The new post
  63          */
  64         public void newPostFound(Post post);
  65
  66         /**
  67          * Notifies a listener that a new reply has been found.
  68          *
  69          * @param reply
  70          *            The new reply
  71          */
  72         public void newReplyFound(Reply reply);
  73
  74         /**
  75          * Notifies a listener that the given Sone is now marked as known.
  76          *
  77          * @param sone
  78          *            The known Sone
  79          */
  80         public void markSoneKnown(Sone sone);
  81
  82         /**
  83          * Notifies a listener that the given post is now marked as known.
  84          *
  85          * @param post
  86          *            The known post
  87          */
  88         public void markPostKnown(Post post);
  89
  90         /**
  91          * Notifies a listener that the given reply is now marked as known.
  92          *
  93          * @param reply
  94          *            The known reply
  95          */
  96         public void markReplyKnown(Reply reply);
  97
  98         /**
  99          * Notifies a listener that the given post was removed.
 100          *
 101          * @param post
 102          *            The removed post
 103          */
 104         public void postRemoved(Post post);
 105
 106         /**
 107          * Notifies a listener that the given reply was removed.
 108          *
 109          * @param reply
 110          *            The removed reply
 111          */
 112         public void replyRemoved(Reply reply);
 113
 114 }