2 * Sone - CoreListener.java - Copyright © 2010 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.core;
20 import java.util.EventListener;
22 import net.pterodactylus.sone.data.Post;
23 import net.pterodactylus.sone.data.Reply;
24 import net.pterodactylus.sone.data.Sone;
25 import net.pterodactylus.util.version.Version;
28 * Listener interface for objects that want to be notified on certain
29 * {@link Core} events, such es discovery of new data.
31 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33 public interface CoreListener extends EventListener {
36 * Notifies a listener that a new Sone has been discovered.
41 public void newSoneFound(Sone sone);
44 * Notifies a listener that a new post has been found.
49 public void newPostFound(Post post);
52 * Notifies a listener that a new reply has been found.
57 public void newReplyFound(Reply reply);
60 * Notifies a listener that the given Sone is now marked as known.
65 public void markSoneKnown(Sone sone);
68 * Notifies a listener that the given post is now marked as known.
73 public void markPostKnown(Post post);
76 * Notifies a listener that the given reply is now marked as known.
81 public void markReplyKnown(Reply reply);
84 * Notifies a listener that the given Sone was removed.
89 public void soneRemoved(Sone sone);
92 * Notifies a listener that the given post was removed.
97 public void postRemoved(Post post);
100 * Notifies a listener that the given reply was removed.
105 public void replyRemoved(Reply reply);
108 * Notifies a listener when a Sone was locked.
111 * The Sone that was locked
113 public void soneLocked(Sone sone);
116 * Notifies a listener that a Sone was unlocked.
119 * The Sone that was unlocked
121 public void soneUnlocked(Sone sone);
124 * Notifies a listener that the insert of the given Sone has started.
126 * @see SoneInsertListener#insertStarted(Sone)
128 * The Sone that is being inserted
130 public void soneInserting(Sone sone);
133 * Notifies a listener that the insert of the given Sone has finished
136 * @see SoneInsertListener#insertFinished(Sone, long)
138 * The Sone that has been inserted
139 * @param insertDuration
140 * The insert duration (in milliseconds)
142 public void soneInserted(Sone sone, long insertDuration);
145 * Notifies a listener that the insert of the given Sone was aborted.
147 * @see SoneInsertListener#insertAborted(Sone, Throwable)
149 * The Sone that was inserted
151 * The cause for the abortion (may be {@code null})
153 public void soneInsertAborted(Sone sone, Throwable cause);
156 * Notifies a listener that a new version has been found.
159 * The version that was found
161 * The release time of the new version
162 * @param latestEdition
163 * The latest edition of the Sone homepage
165 public void updateFound(Version version, long releaseTime, long latestEdition);