Changeset 175 for trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandExecuter.java

Timestamp:

09/09/11 23:52:51 (13 years ago)

Author:

sherbold

Message:

• code documentation and formatting

File:

• trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandExecuter.java (modified) (8 diffs)

trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandExecuter.java

@@ -4 +4 @@
 import java.util.ArrayList;
 import java.util.List;
-
 
 /**
@@ -14 +13 @@
  * </p>
  * <p>
- * This class is implemented as a <i>Singleton</i>. 
+ * This class is implemented as a <i>Singleton</i>.
  * </p>
  * 
  * @author Steffen Herbold
+ * @version 1.0
  */
 public class CommandExecuter {
@@ -34 +34 @@
          */
         private static final String cmdPrefix = "CMD";
-        
+
         /**
          * <p>
@@ -48 +48 @@
          * </p>
          * <p>
-         * The defaultcommands package has always lowest priority, unless it is
-         * specificially added.
+         * The de.ugoe.cs.util.console.defaultcommands package has always lowest
+         * priority, unless it is specifically added.
          * </p>
          */
@@ -78 +78 @@
         /**
          * <p>
-         * Adds a package that will be used by exec to load command from.
+         * Adds a package that will be used by {@link #exec(String)} to load command
+         * from.
          * </p>
          * 
@@ -111 +112 @@
                 parser.parse(command);
                 for (int i = 0; cmd == null && i < commandPackageList.size(); i++) {
-                        cmd = loadCMD(commandPackageList.get(i)+"."+cmdPrefix+parser.getCommandName());
+                        cmd = loadCMD(commandPackageList.get(i) + "." + cmdPrefix
+                                        + parser.getCommandName());
                 }
                 if (cmd == null) { // check if command is available as default command
-                        cmd = loadCMD(defaultPackage+"."+cmdPrefix+parser.getCommandName());
+                        cmd = loadCMD(defaultPackage + "." + cmdPrefix
+                                        + parser.getCommandName());
                 }
                 if (cmd == null) {
@@ -128 +131 @@
 
         /**
+         * <p>
          * Helper method that loads a class and tries to cast it to {@link Command}.
+         * </p>
          * 
-         * @param className qualified name of the class (including package name)
-         * @return if class is available and implement {@link Command} and instance of the class, null otherwise
+         * @param className
+         *            qualified name of the class (including package name)
+         * @return if class is available and implement {@link Command} and instance
+         *         of the class, null otherwise
          */
         private Command loadCMD(String className) {
@@ -140 +147 @@
                 } catch (NoClassDefFoundError e) {
                         String[] splitResult = e.getMessage().split("CMD");
-                        String correctName = splitResult[splitResult.length-1].replace(")", "");
+                        String correctName = splitResult[splitResult.length - 1].replace(
+                                        ")", "");
                         Console.traceln("Did you mean " + correctName + "?");
                 } catch (ClassNotFoundException e) {