Changeset 664 for trunk/java-utils

Timestamp:

08/28/12 13:33:23 (12 years ago)

Author:

sherbold

Message:

• modified Command.help(): the help now returns a string with its usage instead of writing directly to the console
• modified listCommands: now writes the help string of each command instead of just the name; this way, the parameters are displayed directly
• moved listCommands from quest-ui-core to java-utils

Location:

trunk/java-utils/src/main/java/de/ugoe/cs/util/console

Files:

• Command.java (modified) (1 diff)
• CommandExecuter.java (modified) (5 diffs)
• defaultcommands/CMDexec.java (modified) (1 diff)
• defaultcommands/CMDexit.java (modified) (2 diffs)
• defaultcommands/CMDlistCommands.java (moved) (moved from trunk/quest-ui-core/src/main/java/de/ugoe/cs/quest/ui/commands/CMDlistCommands.java) (3 diffs)

trunk/java-utils/src/main/java/de/ugoe/cs/util/console/Command.java

@@ -27 +27 @@
         /**
          * <p>
-         * Sends information about how to use a command to the console.
+         * Returns a string the contains information about how to use the command.
          * </p>
+         * @return help string
          */
-        public void help();
+        public String help();
 }

trunk/java-utils/src/main/java/de/ugoe/cs/util/console/CommandExecuter.java

@@ -10 +10 @@
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.Enumeration;
 import java.util.List;
@@ -138 +140 @@
             }
             catch (InvalidParameterException e) {
-                cmd.help();
+                Console.println("Usage: " + cmd.help());
             }
         }
@@ -181 +183 @@
      * @return an array containing the names of the available commands.
      */
-    public String[] getAvailableCommands() {
-        List<String> commands = new ArrayList<String>();
+    public Command[] getAvailableCommands() {
+        List<Command> commands = new ArrayList<Command>();
         List<String> packages = new ArrayList<String>();
         packages.addAll(commandPackageList);
@@ -251 +253 @@
         }
         
+        Collections.sort(classNames, new Comparator<String>() {
+            @Override
+            public int compare(String arg1, String arg2) {
+                String str1 = arg1.substring(arg1.lastIndexOf('.') + cmdPrefix.length() + 1);
+                String str2 = arg2.substring(arg2.lastIndexOf('.') + cmdPrefix.length() + 1);
+                return str1.compareTo(str2);
+            }
+            
+        });
         for (String className : classNames) {
             String commandStr =
@@ -261 +272 @@
                 // class may still be inner classes. Therefore load the command, to
                 // see if it is really available and a command.
-                if (loadCMD(className) != null) {
-                    commands.add(commandStr);
+                Command cmd = loadCMD(className);
+                if (cmd != null) {
+                    commands.add(cmd);
                 }
             }
         }
         
-        String[] commandArray = commands.toArray(new String[commands.size()]);
-        Arrays.sort(commandArray);
+        Command[] commandArray = commands.toArray(new Command[commands.size()]);
         return commandArray;
     }

trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexec.java

@@ -63 +63 @@
          */
         @Override
-        public void help() {
-                Console.println("Usage: exec <filename>");
+        public String help() {
+                return "exec <filename>";
         }
 }

trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDexit.java

@@ -4 +4 @@
 
 import de.ugoe.cs.util.console.Command;
-import de.ugoe.cs.util.console.Console;
 
 /**
@@ -22 +21 @@
          */
         @Override
-        public void help() {
-                Console.println("Usage: exit");
+        public String help() {
+                return "exit";
         }
 

trunk/java-utils/src/main/java/de/ugoe/cs/util/console/defaultcommands/CMDlistCommands.java

@@ -1 +1 @@
 
-package de.ugoe.cs.quest.ui.commands;
+package de.ugoe.cs.util.console.defaultcommands;
 
 import java.util.List;
@@ -25 +25 @@
     @Override
     public void run(List<Object> parameters) {
-        String[] commands = CommandExecuter.getInstance().getAvailableCommands();
+        Command[] commands = CommandExecuter.getInstance().getAvailableCommands();
 
-        for (String command : commands) {
-            Console.println(command);
+        for (Command command : commands) {
+            Console.println(command.help());
         }
     }
@@ -38 +38 @@
      */
     @Override
-    public void help() {
-        Console.println("Usage: listCommands");
+    public String help() {
+        return "listCommands";
     }