Start work on 'auto commands'.

This is going to replace the perform wrappers. Better name
suggestions on a postcard.

Change-Id: I19fc055d275d25cf9c24fe8a56cba73ea24c2b6a
Reviewed-on: http://gerrit.dmdirc.com/3664
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/commandparser/auto/AutoCommand.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser.auto;
+
+import com.google.common.base.Optional;
+
+/**
+ * Describes a command that is executed automatically in response to either the client opening, or a
+ * server connecting.
+ */
+public class AutoCommand {
+
+    /** The name of the server for connection events. */
+    private final Optional<String> server;
+    /** The name of the network for connection events. */
+    private final Optional<String> network;
+    /** The name of the profile for connection events. */
+    private final Optional<String> profile;
+    /** The commands to execute. */
+    private final String response;
+
+    public AutoCommand(
+            final Optional<String> server,
+            final Optional<String> network,
+            final Optional<String> profile,
+            final String response) {
+        this.server = server;
+        this.network = network;
+        this.profile = profile;
+        this.response = response;
+    }
+
+    public Optional<String> getServer() {
+        return server;
+    }
+
+    public Optional<String> getNetwork() {
+        return network;
+    }
+
+    public Optional<String> getProfile() {
+        return profile;
+    }
+
+    public String getResponse() {
+        return response;
+    }
+
+}

src/com/dmdirc/commandparser/auto/AutoCommandStore.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser.auto;
+
+import java.util.Set;
+
+/**
+ * A store of {@link AutoCommand}s that can read and write them to some kind of persistent media.
+ */
+public interface AutoCommandStore {
+
+    /**
+     * Reads and returns all auto commands from within the store.
+     *
+     * @return A set of known auto commands, or an empty set if the store is uninitialised.
+     */
+    Set<AutoCommand> readAutoCommands();
+
+    /**
+     * Writes all the given auto commands to the store, replacing any existing commands.
+     *
+     * @param aliases The set of auto command to be written to the store.
+     */
+    void writeAutoCommands(Set<AutoCommand> aliases);
+
+}