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>
28 public interface CoreListener {
31 // project configuration
35 * Notifies a listener that loading the projects finished successfully.
38 * The directory the nodes were loaded from
40 public void loadingProjectsDone(String directory);
43 * Notifies all listeners that loading the projects has failed.
46 * The directory the projects were tried to load from
48 * The exception that occured while saving, if any
50 public void loadingProjectsFailed(String directory, Throwable throwable);
53 * Notifies a listener that the projects were successfully saved to the
57 * The directory the projects were saved to
59 public void savingProjectsDone(String directory);
62 * Notifies a listener that saving the projects has failed.
65 * The directory the projects were to be saved to
67 * The exception that occured when saving the projects, if any
69 public void savingProjectsFailed(String directory, Throwable throwable);
76 * Notifies a listener that the nodes were successfully loaded.
79 * The directory the nodes were loaded from
81 public void loadingNodesDone(String directory);
84 * Notifies a listener that loading the nodes has failed.
87 * The directory the nodes were loaded from
89 * The exception that occured while loading the nodes
91 public void loadingNodesFailed(String directory, Throwable throwable);
94 * Notifies a listener that the nodes were successfully saved.
97 * The directory the nodes were saved to
99 public void savingNodesDone(String directory);
102 * Notifies a listener that saving the nodes has failed.
105 * The directory the nodes were saved to
107 * The exception that occured while saving the nodes
109 public void savingNodesFailed(String directory, Throwable throwable);
112 // basic core functionality
116 * Notifies all listeners that the core has loaded.
118 public void coreLoaded();
121 * Notifies a listener that the core was stopped.
123 public void coreStopped();
130 * Notifies a listener that a node was added to the core.
133 * The node that was added.
135 public void nodeAdded(Node node);
138 * Notifies a listener that a node was removed from the core. Before a node
139 * is removed, it will be disconnected (and
140 * {@link #nodeDisconnected(Node, Throwable)} will be called).
143 * The node that was removed
145 public void nodeRemoved(Node node);
148 * Notifies all listeners that the core started connecting to the given
149 * node. Before a node is connected, it will be added (and
150 * {@link #nodeAdded(Node)} will be called).
153 * The node that is being connected
155 public void nodeConnecting(Node node);
158 * Notifies all listeners that the core connected to the given node.
161 * The node that is connected
163 public void nodeConnected(Node node);
166 * Notifies all listeners that the core disconnected from the given node.
169 * The node that was diconnected
171 * The exception that caused the disconnect, or <code>null</code>
172 * if there was no exception
174 public void nodeDisconnected(Node node, Throwable throwable);
181 * Notifies a listener that a request was added to a node.
184 * The node the request was added to
186 * The request that was added
188 public void requestAdded(Node node, Request request);
191 * Notifies a listener that a request made some progress.
194 * The request that made the progress
196 * The total number of blocks
197 * @param requiredBlocks
198 * The number of required blocks
199 * @param successfulBlocks
200 * The number of successful blocks
201 * @param failedBlocks
202 * The number of failed blocks
203 * @param fatallyFailedBlocks
204 * The number of fatally failed blocks
205 * @param finalizedTotal
206 * <code>true</code> if the number of total blocks is
207 * finalized, <code>false</code> if it is not
209 public void requestProgressed(Request request, int totalBlocks, int requiredBlocks, int successfulBlocks, int failedBlocks, int fatallyFailedBlocks, boolean finalizedTotal);