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

   1 /*
   2  * jSite2 - Core.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 import java.util.List;
  23
  24 /**
  25  * Interface for the core.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  * @version $Id$
  29  */
  30 public interface Core {
  31
  32         /**
  33          * Adds the given listener to the list of registered listeners.
  34          *
  35          * @param coreListener
  36          *            The listener to add
  37          */
  38         public void addCoreListener(CoreListener coreListener);
  39
  40         /**
  41          * Removes the given listener from the list of registered listeners.
  42          *
  43          * @param coreListener
  44          *            The listener to remove
  45          */
  46         public void removeCoreListener(CoreListener coreListener);
  47
  48         /**
  49          * Adds the given node to the core.
  50          *
  51          * @param node
  52          *            The node to add
  53          */
  54         public void addNode(Node node);
  55
  56         /**
  57          * Removes the given node from the core.
  58          *
  59          * @param node
  60          *            The node to remove
  61          */
  62         public void removeNode(Node node);
  63
  64         /**
  65          * Returns the list of all configured nodes.
  66          *
  67          * @return All configured nodes
  68          */
  69         public List<Node> getNodes();
  70
  71         /**
  72          * Returns whether the core is currently connected to the given node.
  73          *
  74          * @param node
  75          *            The node to check
  76          * @return <code>true</code> if the core is currently connected to the
  77          *         node, <code>false</code> otherwise
  78          */
  79         public boolean isNodeConnected(Node node);
  80
  81         /**
  82          * Starts the core.
  83          */
  84         public void start();
  85
  86         /**
  87          * Stops the core.
  88          */
  89         public void stop();
  90
  91         /**
  92          * Connects to the given node.
  93          *
  94          * @param node
  95          *            The node to connect to
  96          */
  97         public void connectToNode(Node node);
  98
  99         /**
 100          * Disconnects from the given node.
 101          *
 102          * @param node
 103          *            The node to disconnect from
 104          */
 105         public void disconnectFromNode(Node node);
 106
 107 }