core interface

git-svn-id: http://trooper/svn/projects/jSite/trunk@786 c3eda9e8-030b-0410-8277-bc7414b0a119

diff --git a/src/net/pterodactylus/jsite/core/Core.java b/src/net/pterodactylus/jsite/core/Core.java
new file mode 100644 (file)
index 0000000..e6cad12
--- /dev/null
+++ b/src/net/pterodactylus/jsite/core/Core.java
@@ -0,0 +1,83 @@
+/*
+ * jSite2 - Core.java -
+ * Copyright © 2008 David Roden
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+
+package net.pterodactylus.jsite.core;
+
+import java.util.List;
+
+/**
+ * Interface for the core.
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
+ * @version $Id$
+ */
+public interface Core {
+
+       /**
+        * Adds the given listener to the list of registered listeners.
+        *
+        * @param coreListener
+        *            The listener to add
+        */
+       public void addCoreListener(CoreListener coreListener);
+
+       /**
+        * Removes the given listener from the list of registered listeners.
+        *
+        * @param coreListener
+        *            The listener to remove
+        */
+       public void removeCoreListener(CoreListener coreListener);
+
+       /**
+        * Returns the list of all configured nodes.
+        *
+        * @return All configured nodes
+        */
+       public List<Node> getNodes();
+
+       /**
+        * Returns whether the core is currently connected to the given node.
+        *
+        * @param node
+        *            The node to check
+        * @return <code>true</code> if the core is currently connected to the
+        *         node, <code>false</code> otherwise
+        */
+       public boolean isNodeConnected(Node node);
+
+       /**
+        * Starts the core.
+        */
+       public void start();
+
+       /**
+        * Stops the core.
+        */
+       public void stop();
+
+       /**
+        * Connects to the given node.
+        *
+        * @param node
+        *            The node to connect to
+        */
+       public void connectToNode(Node node);
+
+}
\ No newline at end of file