Convert “Sone removed” into EventBus-based event.
[Sone.git] / 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 the given post was removed.
38          *
39          * @param post
40          *            The removed post
41          */
42         public void postRemoved(Post post);
43
44         /**
45          * Notifies a listener that the given reply was removed.
46          *
47          * @param reply
48          *            The removed reply
49          */
50         public void replyRemoved(PostReply reply);
51
52         /**
53          * Notifies a listener when a Sone was locked.
54          *
55          * @param sone
56          *            The Sone that was locked
57          */
58         public void soneLocked(Sone sone);
59
60         /**
61          * Notifies a listener that a Sone was unlocked.
62          *
63          * @param sone
64          *            The Sone that was unlocked
65          */
66         public void soneUnlocked(Sone sone);
67
68         /**
69          * Notifies a listener that the insert of the given Sone has started.
70          *
71          * @see SoneInsertListener#insertStarted(Sone)
72          * @param sone
73          *            The Sone that is being inserted
74          */
75         public void soneInserting(Sone sone);
76
77         /**
78          * Notifies a listener that the insert of the given Sone has finished
79          * successfully.
80          *
81          * @see SoneInsertListener#insertFinished(Sone, long)
82          * @param sone
83          *            The Sone that has been inserted
84          * @param insertDuration
85          *            The insert duration (in milliseconds)
86          */
87         public void soneInserted(Sone sone, long insertDuration);
88
89         /**
90          * Notifies a listener that the insert of the given Sone was aborted.
91          *
92          * @see SoneInsertListener#insertAborted(Sone, Throwable)
93          * @param sone
94          *            The Sone that was inserted
95          * @param cause
96          *            The cause for the abortion (may be {@code null})
97          */
98         public void soneInsertAborted(Sone sone, Throwable cause);
99
100         /**
101          * Notifies a listener that a new version has been found.
102          *
103          * @param version
104          *            The version that was found
105          * @param releaseTime
106          *            The release time of the new version
107          * @param latestEdition
108          *            The latest edition of the Sone homepage
109          */
110         public void updateFound(Version version, long releaseTime, long latestEdition);
111
112         /**
113          * Notifies a listener that an image has started being inserted.
114          *
115          * @param image
116          *            The image that is now inserted
117          */
118         public void imageInsertStarted(Image image);
119
120         /**
121          * Notifies a listener that an image insert was aborted by the user.
122          *
123          * @param image
124          *            The image that is not inserted anymore
125          */
126         public void imageInsertAborted(Image image);
127
128         /**
129          * Notifies a listener that an image was successfully inserted.
130          *
131          * @param image
132          *            The image that was inserted
133          */
134         public void imageInsertFinished(Image image);
135
136         /**
137          * Notifies a listener that an image failed to be inserted.
138          *
139          * @param image
140          *            The image that could not be inserted
141          * @param cause
142          *            The reason for the failed insert
143          */
144         public void imageInsertFailed(Image image, Throwable cause);
145
146 }