re-added ConsoleInterpreter for openHAB 1 build (#67)

Signed-off-by: Kai Kreuzer <kai@openhab.org>

bundles/org.openhab.core.compat1x/src/main/java/org/openhab/io/console/ConsoleInterpreter.java

@@ -0,0 +1,122 @@
+/**
+ * Copyright (c) 2015-2016 by the respective copyright holders.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.openhab.io.console;
+
+/**
+ * This class provides generic methods for handling console input (i.e. pure strings).
+ *
+ * NOTE: This class is only kept for backward compatibility so that openHAB 1 Add-ons still compile.
+ * It must not be used productively!
+ *
+ * @author Kai Kreuzer
+ * @since 0.4.0
+ *
+ */
+public class ConsoleInterpreter {
+
+    /**
+     * This method simply takes a list of arguments, where the first one is treated
+     * as the console command (such as "update", "send" etc.). The following entries
+     * are then the arguments for this command.
+     * If the command is unknown, the complete usage is printed to the console.
+     *
+     * @param args array which contains the console command and all its arguments
+     * @param console the console for printing messages for the user
+     */
+    static public void handleRequest(String[] args, Console console) {
+    }
+
+    /**
+     * This method handles an update command.
+     *
+     * @param args array which contains the arguments for the update command
+     * @param console the console for printing messages for the user
+     */
+    static public void handleUpdate(String[] args, Console console) {
+    }
+
+    /**
+     * This method handles a send command.
+     *
+     * @param args array which contains the arguments for the send command
+     * @param console the console for printing messages for the user
+     */
+    static public void handleSend(String[] args, Console console) {
+    }
+
+    /**
+     * This method handles an items command.
+     *
+     * @param args array which contains the arguments for the items command
+     * @param console the console for printing messages for the user
+     */
+    static public void handleItems(String[] args, Console console) {
+    }
+
+    /**
+     * This method handles a status command.
+     *
+     * @param args array which contains the arguments for the status command
+     * @param console the console for printing messages for the user
+     */
+    static public void handleStatus(String[] args, Console console) {
+    }
+
+    /**
+     * This method handles a say command.
+     *
+     * @param args array which contains the arguments for the status command
+     * @param console the console for printing messages for the user
+     */
+    static public void handleSay(String[] args, Console console) {
+    }
+
+    public static void handleScript(String[] args, Console console) {
+    }
+
+    /** returns a CR-separated list of usage texts for all available commands */
+    private static String getUsage() {
+        StringBuilder sb = new StringBuilder();
+        for (String usage : ConsoleInterpreter.getUsages()) {
+            sb.append(usage + "\n");
+        }
+        return sb.toString();
+    }
+
+    /** returns an array of the usage texts for all available commands */
+    static public String[] getUsages() {
+        return new String[] { getUpdateUsage(), getCommandUsage(), getStatusUsage(), getItemsUsage(), getSayUsage(),
+                getScriptUsage() };
+    }
+
+    static public String getUpdateUsage() {
+        return "update <item> <state> - sends a status update for an item";
+    }
+
+    static public String getCommandUsage() {
+        return "send <item> <command> - sends a command for an item";
+    }
+
+    static public String getStatusUsage() {
+        return "status <item> - shows the current status of an item";
+    }
+
+    static public String getItemsUsage() {
+        return "items [<pattern>] - lists names and types of all items matching the pattern";
+    }
+
+    public static String getSayUsage() {
+        return "say <sentence to say> - Says a message through TTS on the host machine";
+    }
+
+    public static String getScriptUsage() {
+        return "> <script to execute> - Executes a script";
+    }
+
+}