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.Image;
23 import net.pterodactylus.sone.data.Post;
24 import net.pterodactylus.sone.data.Reply;
25 import net.pterodactylus.sone.data.Sone;
26 import net.pterodactylus.util.version.Version;
29 * Listener interface for objects that want to be notified on certain
30 * {@link Core} events, such es discovery of new data.
32 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34 public interface CoreListener extends EventListener {
37 * Notifies a listener that a new Sone has been discovered.
42 public void newSoneFound(Sone sone);
45 * Notifies a listener that a new post has been found.
50 public void newPostFound(Post post);
53 * Notifies a listener that a new reply has been found.
58 public void newReplyFound(Reply reply);
61 * Notifies a listener that the given Sone is now marked as known.
66 public void markSoneKnown(Sone sone);
69 * Notifies a listener that the given post is now marked as known.
74 public void markPostKnown(Post post);
77 * Notifies a listener that the given reply is now marked as known.
82 public void markReplyKnown(Reply reply);
85 * Notifies a listener that the given Sone was removed.
90 public void soneRemoved(Sone sone);
93 * Notifies a listener that the given post was removed.
98 public void postRemoved(Post post);
101 * Notifies a listener that the given reply was removed.
106 public void replyRemoved(Reply reply);
109 * Notifies a listener when a Sone was locked.
112 * The Sone that was locked
114 public void soneLocked(Sone sone);
117 * Notifies a listener that a Sone was unlocked.
120 * The Sone that was unlocked
122 public void soneUnlocked(Sone sone);
125 * Notifies a listener that the insert of the given Sone has started.
127 * @see SoneInsertListener#insertStarted(Sone)
129 * The Sone that is being inserted
131 public void soneInserting(Sone sone);
134 * Notifies a listener that the insert of the given Sone has finished
137 * @see SoneInsertListener#insertFinished(Sone, long)
139 * The Sone that has been inserted
140 * @param insertDuration
141 * The insert duration (in milliseconds)
143 public void soneInserted(Sone sone, long insertDuration);
146 * Notifies a listener that the insert of the given Sone was aborted.
148 * @see SoneInsertListener#insertAborted(Sone, Throwable)
150 * The Sone that was inserted
152 * The cause for the abortion (may be {@code null})
154 public void soneInsertAborted(Sone sone, Throwable cause);
157 * Notifies a listener that a new version has been found.
160 * The version that was found
162 * The release time of the new version
163 * @param latestEdition
164 * The latest edition of the Sone homepage
166 public void updateFound(Version version, long releaseTime, long latestEdition);
169 * Notifies a listener that an image has started being inserted.
172 * The image that is now inserted
174 public void imageInsertStarted(Image image);
177 * Notifies a listener that an image insert was aborted by the user.
180 * The image that is not inserted anymore
182 public void imageInsertAborted(Image image);
185 * Notifies a listener that an image was successfully inserted.
188 * The image that was inserted
190 public void imageInsertFinished(Image image);
193 * Notifies a listener that an image failed to be inserted.
196 * The image that could not be inserted
198 * The reason for the failed insert
200 public void imageInsertFailed(Image image, Throwable cause);