Add abstract FCP command with Sone-specific helper methods.

diff --git a/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java b/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java
new file mode 100644 (file)
index 0000000..567fe73
--- /dev/null
+++ b/src/main/java/net/pterodactylus/sone/fcp/AbstractSoneCommand.java
@@ -0,0 +1,122 @@
+/*
+ * Sone - FcpInterface.java - Copyright © 2011 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 3 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, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.fcp;
+
+import java.util.Collection;
+
+import net.pterodactylus.sone.core.Core;
+import net.pterodactylus.sone.data.Post;
+import net.pterodactylus.sone.data.Sone;
+import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder;
+import net.pterodactylus.sone.freenet.fcp.AbstractCommand;
+import net.pterodactylus.sone.freenet.fcp.Command;
+import net.pterodactylus.sone.freenet.fcp.FcpException;
+import freenet.node.FSParseException;
+import freenet.support.SimpleFieldSet;
+
+/**
+ * Abstract base implementation of a {@link Command} with Sone-related helper
+ * methods.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public abstract class AbstractSoneCommand extends AbstractCommand {
+
+       /** The Sone core. */
+       private final Core core;
+
+       /**
+        * Creates a new abstract Sone FCP command.
+        *
+        * @param core
+        *            The Sone core
+        */
+       protected AbstractSoneCommand(Core core) {
+               this.core = core;
+       }
+
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns the Sone core.
+        *
+        * @return The Sone core
+        */
+       protected Core getCore() {
+               return core;
+       }
+
+       //
+       // PROTECTED METHODS
+       //
+
+       /**
+        * Returns a Sone whose ID is a parameter in the given simple field set.
+        *
+        * @param simpleFieldSet
+        *            The simple field set containing the ID of the Sone
+        * @param parameterName
+        *            The name under which the Sone ID is stored in the simple field
+        *            set
+        * @return The Sone
+        * @throws FcpException
+        *             if there is no Sone ID stored under the given parameter name,
+        *             or if the Sone ID is invalid
+        */
+       protected Sone getSone(SimpleFieldSet simpleFieldSet, String parameterName) throws FcpException {
+               try {
+                       String soneId = simpleFieldSet.getString(parameterName);
+                       Sone sone = core.getSone(soneId, false);
+                       if (sone == null) {
+                               throw new FcpException("Could not load Sone from “" + soneId + "”.");
+                       }
+                       return sone;
+               } catch (FSParseException fspe1) {
+                       throw new FcpException("Could not load Sone ID from “" + parameterName + "”.", fspe1);
+               }
+       }
+
+       /**
+        * Creates a simple field set from the given collection of posts.
+        *
+        * @param posts
+        *            The posts to encode
+        * @return The simple field set containing the posts
+        */
+       public SimpleFieldSet encodePosts(Collection<? extends Post> posts) {
+               SimpleFieldSetBuilder postBuilder = new SimpleFieldSetBuilder();
+
+               int postIndex = 0;
+               postBuilder.put("Posts.Count", posts.size());
+               for (Post post : posts) {
+                       String postPrefix = "Posts." + postIndex++;
+                       postBuilder.put(postPrefix + ".ID", post.getId());
+                       postBuilder.put(postPrefix + ".Sone", post.getSone().getId());
+                       if (post.getRecipient() != null) {
+                               postBuilder.put(postPrefix + ".Recipient", post.getRecipient().getId());
+                       }
+                       postBuilder.put(postPrefix + ".Time", post.getTime());
+                       postBuilder.put(postPrefix + ".Text", post.getText());
+               }
+
+               return postBuilder.get();
+       }
+
+}