2 * jSite2 - UserInterface.java -
3 * Copyright © 2008 David Roden
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 package net.pterodactylus.jsite.core;
23 * Interface definition for user interfaces.
25 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
27 public interface CoreListener {
30 // project configuration
34 * Notifies a listener that loading the projects finished successfully.
37 * The directory the nodes were loaded from
39 public void loadingProjectsDone(String directory);
42 * Notifies all listeners that loading the projects has failed.
45 * The directory the projects were tried to load from
47 * The exception that occured while saving, if any
49 public void loadingProjectsFailed(String directory, Throwable throwable);
52 * Notifies a listener that the projects were successfully saved to the
56 * The directory the projects were saved to
58 public void savingProjectsDone(String directory);
61 * Notifies a listener that saving the projects has failed.
64 * The directory the projects were to be saved to
66 * The exception that occured when saving the projects, if any
68 public void savingProjectsFailed(String directory, Throwable throwable);
71 * Notifies a listener that the given project was added.
74 * The project that was added.
76 public void projectAdded(Project project);
79 * Notifies a listener that a project was cloned.
81 * @param clonedProject
84 * The clone of the project
86 public void projectCloned(Project clonedProject, Project projectClone);
89 * Notifies a listener that the given project was removed.
92 * The project that was removed.
94 public void projectRemoved(Project project);
101 * Notifies a listener that the nodes were successfully loaded.
104 * The directory the nodes were loaded from
106 public void loadingNodesDone(String directory);
109 * Notifies a listener that loading the nodes has failed.
112 * The directory the nodes were loaded from
114 * The exception that occured while loading the nodes
116 public void loadingNodesFailed(String directory, Throwable throwable);
119 * Notifies a listener that the nodes were successfully saved.
122 * The directory the nodes were saved to
124 public void savingNodesDone(String directory);
127 * Notifies a listener that saving the nodes has failed.
130 * The directory the nodes were saved to
132 * The exception that occured while saving the nodes
134 public void savingNodesFailed(String directory, Throwable throwable);
137 // basic core functionality
141 * Notifies all listeners that the core has loaded.
143 public void coreLoaded();
146 * Notifies a listener that the core was stopped.
148 public void coreStopped();
155 * Notifies a listener that a node was added to the core.
158 * The node that was added.
160 public void nodeAdded(Node node);
163 * Notifies a listener that a node was removed from the core. Before a node
164 * is removed, it will be disconnected (and
165 * {@link #nodeDisconnected(Node, Throwable)} will be called).
168 * The node that was removed
170 public void nodeRemoved(Node node);
173 * Notifies all listeners that the core started connecting to the given
174 * node. Before a node is connected, it will be added (and
175 * {@link #nodeAdded(Node)} will be called).
178 * The node that is being connected
180 public void nodeConnecting(Node node);
183 * Notifies all listeners that the core connected to the given node.
186 * The node that is connected
188 public void nodeConnected(Node node);
191 * Notifies a listener that a connection to a node has failed.
194 * The node that could not be connected
196 * The cause of the failure
198 public void nodeConnectionFailed(Node node, Throwable cause);
201 * Notifies all listeners that the core disconnected from the given node.
204 * The node that was diconnected
206 * The exception that caused the disconnect, or <code>null</code>
207 * if there was no exception
209 public void nodeDisconnected(Node node, Throwable throwable);
212 // project insertion stuff
216 * Notifies a listener that a project insert started.
219 * The project that is now inserting
221 public void projectInsertStarted(Project project);
224 * Notifies a listener that a project insert made progress.
227 * The project that made progress
229 * The number of total blocks
230 * @param requiredBlocks
231 * The number of required blocks
232 * @param successfulBlocks
233 * The number of successfully inserted blocks
234 * @param failedBlocks
235 * The number of blocks that could not be inserted
236 * @param fatallyFailedBlocks
237 * The number of blocks that can not be inserted even with
239 * @param finalizedTotal
240 * <code>true</code> if the number of total blocks is already
241 * finalized, <code>false</code> otherwise
243 public void projectInsertProgressed(Project project, int totalBlocks, int requiredBlocks, int successfulBlocks, int failedBlocks, int fatallyFailedBlocks, boolean finalizedTotal);
246 * Notifies a listener that a project insert has generated a URI.
249 * The project that generated a URI
251 * The URI that was generated
253 public void projectInsertGeneratedURI(Project project, String uri);
256 * Notifies a listener that a project insert has finished.
259 * The project that has finished
261 * <code>true</code> if the project was inserted successfully,
262 * <code>false</code> otherwise
264 public void projectInsertFinished(Project project, boolean success);