Reformatting.
[jSite2.git] / src / net / pterodactylus / jsite / core / Core.java
index 3e8357d..53cd6b7 100644 (file)
@@ -22,18 +22,18 @@ package net.pterodactylus.jsite.core;
 import java.io.IOException;
 import java.net.UnknownHostException;
 import java.util.List;
+import java.util.concurrent.Executor;
 
 /**
  * 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
         */
@@ -41,19 +41,26 @@ public interface Core {
 
        /**
         * Removes the given listener from the list of registered listeners.
-        * 
+        *
         * @param coreListener
         *            The listener to remove
         */
        public void removeCoreListener(CoreListener coreListener);
 
        /**
+        * Returns a thread pool.
+        *
+        * @return A thread pool
+        */
+       public Executor getThreadPool();
+
+       /**
         * Adds the given node to the core.
-        * 
+        *
         * @param node
         *            The node to add
-        * @return <code>true</code> if the node was added, <code>false</code>
-        *         if it was not added because it was already known
+        * @return <code>true</code> if the node was added, <code>false</code> if it
+        *         was not added because it was already known
         * @throws UnknownHostException
         *             if the hostname of the node can not be resolved
         */
@@ -61,7 +68,7 @@ public interface Core {
 
        /**
         * Removes the given node from the core.
-        * 
+        *
         * @param node
         *            The node to remove
         */
@@ -69,18 +76,18 @@ public interface Core {
 
        /**
         * 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
+        * @return <code>true</code> if the core is currently connected to the node,
+        *         <code>false</code> otherwise
         */
        public boolean isNodeConnected(Node node);
 
@@ -96,7 +103,7 @@ public interface Core {
 
        /**
         * Connects to the given node.
-        * 
+        *
         * @param node
         *            The node to connect to
         */
@@ -104,22 +111,45 @@ public interface Core {
 
        /**
         * Disconnects from the given node.
-        * 
+        *
         * @param node
         *            The node to disconnect from
         */
        public void disconnectFromNode(Node node);
 
        /**
-        * Creates a new project. The returned {@link Project} will contain a newly
-        * generated key pair.
-        * 
-        * @return A newly created project
+        * Creates a new project.
+        *
         * @throws IOException
         *             if an I/O error occured communicating with the node
-        * @throws NoNodeException
-        *             if no node is configured
+        * @throws JSiteException
+        *             if there is a problem with the node
+        */
+       public void createProject() throws IOException, JSiteException;
+
+       /**
+        * Clones the given project. {@link CoreListener}s will be notified of the
+        * new clone via the {@link CoreListener#projectCloned(Project, Project)}
+        * event.
+        *
+        * @param project
+        *            The project to clone
+        */
+       public void cloneProject(Project project);
+
+       /**
+        * Removes the given project.
+        *
+        * @param project
+        *            The project to remove
+        */
+       public void removeProject(Project project);
+
+       /**
+        * Returns a list of all projects.
+        *
+        * @return A list of all projects
         */
-       public Project createProject() throws IOException, NoNodeException;
+       public List<Project> getProjects();
 
 }