src/net/pterodactylus/jsite/core/CoreListener.java

   1 /*
   2  * jSite2 - UserInterface.java -
   3  * Copyright © 2008 David Roden
   4  *
   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.
   9  *
  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.
  14  *
  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.
  18  */
  19
  20 package net.pterodactylus.jsite.core;
  21
  22 /**
  23  * Interface definition for user interfaces.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  * @version $Id$
  27  */
  28 public interface CoreListener {
  29
  30         //
  31         // configuration stuff
  32         //
  33
  34         /**
  35          * Notifies all listeners that loading the projects has failed.
  36          *
  37          * @param directory
  38          *            The directory the projects were tried to load from
  39          * @param throwable
  40          *            The exception that occured while saving, if any
  41          */
  42         public void loadingProjectsFailed(String directory, Throwable throwable);
  43
  44         /**
  45          * Notifies a listener that the projects were successfully saved to the
  46          * given directory.
  47          *
  48          * @param directory
  49          *            The directory the projects were saved to
  50          */
  51         public void savingProjectsDone(String directory);
  52
  53         /**
  54          * Notifies a listener that saving the projects has failed.
  55          *
  56          * @param directory
  57          *            The directory the projects were to be saved to
  58          * @param throwable
  59          *            The exception that occured when saving the projects, if any
  60          */
  61         public void savingProjectsFailed(String directory, Throwable throwable);
  62
  63         //
  64         // basic core functionality
  65         //
  66
  67         /**
  68          * Notifies all listeners that the core has loaded.
  69          */
  70         public void coreLoaded();
  71
  72         /**
  73          * Notifies a listener that the core was stopped.
  74          */
  75         public void coreStopped();
  76
  77         //
  78         // node stuff
  79         //
  80
  81         /**
  82          * Notifies all listeners that the core started connecting to the given
  83          * node.
  84          *
  85          * @param node
  86          *            The node that is being connected
  87          */
  88         public void nodeConnecting(Node node);
  89
  90         /**
  91          * Notifies all listeners that the core connected to the given node.
  92          *
  93          * @param node
  94          *            The node that is connected
  95          */
  96         public void nodeConnected(Node node);
  97
  98         /**
  99          * Notifies all listeners that the core disconnected from the given node.
 100          *
 101          * @param node
 102          *            The node that was diconnected
 103          */
 104         public void nodeDisconnected(Node node);
 105
 106 }