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          * Returns the list of all configured nodes.
  50          *
  51          * @return All configured nodes
  52          */
  53         public List<Node> getNodes();
  54
  55         /**
  56          * Returns whether the core is currently connected to the given node.
  57          *
  58          * @param node
  59          *            The node to check
  60          * @return <code>true</code> if the core is currently connected to the
  61          *         node, <code>false</code> otherwise
  62          */
  63         public boolean isNodeConnected(Node node);
  64
  65         /**
  66          * Starts the core.
  67          */
  68         public void start();
  69
  70         /**
  71          * Stops the core.
  72          */
  73         public void stop();
  74
  75         /**
  76          * Connects to the given node.
  77          *
  78          * @param node
  79          *            The node to connect to
  80          */
  81         public void connectToNode(Node node);
  82
  83         /**
  84          * Disconnects from the given node.
  85          *
  86          * @param node
  87          *            The node to disconnect from
  88          */
  89         public void disconnectFromNode(Node node);
  90
  91 }