+ * Helper class that provides methods to simplify working with arrays. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ final public class ArrayTools { - + /** *- * Finds the first occurence of an object inside an array. + * Finds the first occurrence of an object inside an array. *
*- * In case {@code other==null}, the first occurence of a {@code null} value in the array is returned. + * In case {@code other==null}, the first occurrence of a {@code null} value + * in the array is returned. *
- * - * @param array the array - * @param other the object + * + * @param array + * the array + * @param other + * the object * @return index of the object if found, -1 otherwise */ public static int findIndex(Object[] array, Object other) { int retVal = -1; - for( int i=0 ; i- * Returns an array of the lines contained in a file. The line seperator is "\r\n". + * Returns an array of the lines contained in a file. The line separator is + * "\r\n". *
- * @param filename name of the file + * + * @param filename + * name of the file * @return string array, where each line contains a file - * @throws IOException see {@link FileReader#read(char[])}, {@link FileReader#close()} - * @throws FileNotFoundException see {@link FileReader#FileReader(File)} + * @throws IOException + * see {@link FileReader#read(char[])}, + * {@link FileReader#close()} + * @throws FileNotFoundException + * see {@link FileReader#FileReader(File)} */ - public static String[] getLinesFromFile(String filename) throws IOException, FileNotFoundException { + public static String[] getLinesFromFile(String filename) + throws IOException, FileNotFoundException { return getLinesFromFile(filename, true); } - + /** ** Returns an array of the lines contained in a file. *
- * @param filename name of the file - * @param carriageReturn if true, "\r\n", if false "\n" is used as line seperator + * + * @param filename + * name of the file + * @param carriageReturn + * if true, "\r\n", if false "\n" is used as line separator * @return string array, where each line contains a file - * @throws IOException see {@link FileReader#read(char[])}, {@link FileReader#close()} - * @throws FileNotFoundException see {@link FileReader#FileReader(File)} + * @throws IOException + * see {@link FileReader#read(char[])}, + * {@link FileReader#close()} + * @throws FileNotFoundException + * see {@link FileReader#FileReader(File)} */ - public static String[] getLinesFromFile(String filename, boolean carriageReturn) throws IOException, FileNotFoundException { + public static String[] getLinesFromFile(String filename, + boolean carriageReturn) throws IOException, FileNotFoundException { File f = new File(filename); FileReader reader = new FileReader(f); @@ -38,5 +60,5 @@ reader.close(); String splitString; - if( carriageReturn ) { + if (carriageReturn) { splitString = "\r\n"; } else { Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/StringTools.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/StringTools.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/StringTools.java (revision 175) @@ -1,18 +1,31 @@ package de.ugoe.cs.util; +/** + *+ * Helper class that provides methods to simplify working with {@link String}s. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ final public class StringTools { - public final static String ENDLINE = System.getProperty("line.separator"); - /** *- * Replaces all occurences of {@literal &, <, >, ', and "} with their - * respective XML entites {@literal &, <, >, ', and "} + * Simplifies use of operation system specific line separators. + *
+ */ + public final static String ENDLINE = System.getProperty("line.separator"); + + /** + *+ * Replaces all occurrences of {@literal &, <, >, ', and "} with their + * respective XML entities {@literal &, <, >, ', and "} * without destroying already existing entities. *
* * @param str - * String where the XML entites are to be replaced - * @return new String, where the XML entites are used instead of the + * String where the XML entities are to be replaced + * @return new String, where the XML entities are used instead of the * literals */ Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Command.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Command.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Command.java (revision 175) @@ -11,4 +11,5 @@ * * @author Steffen Herbold + * @version 1.0 */ public interface Command { Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandExecuter.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandExecuter.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandExecuter.java (revision 175) @@ -4,5 +4,4 @@ import java.util.ArrayList; import java.util.List; - /** @@ -14,8 +13,9 @@ * *- * This class is implemented as a Singleton. + * This class is implemented as a Singleton. *
* * @author Steffen Herbold + * @version 1.0 */ public class CommandExecuter { @@ -34,5 +34,5 @@ */ private static final String cmdPrefix = "CMD"; - + /** *@@ -48,6 +48,6 @@ *
*- * 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. *
*/ @@ -78,5 +78,6 @@ /** *- * 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. *
* @@ -111,8 +112,10 @@ 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,8 +131,12 @@ /** + ** Helper method that loads a class and tries to cast it to {@link Command}. + *
* - * @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,5 +147,6 @@ } 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) { Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandParser.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandParser.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/console/CommandParser.java (revision 175) @@ -10,4 +10,5 @@ * * @author Steffen Herbold + * @version 1.0 */ public class CommandParser { Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Console.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Console.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Console.java (revision 175) @@ -5,5 +5,4 @@ import de.ugoe.cs.util.StringTools; - /** @@ -23,4 +22,5 @@ * * @author Steffen Herbold + * @version 1.0 */ public final class Console { @@ -120,6 +120,5 @@ } for (ConsoleObserver observer : theInstance.observers) { - observer.updateText(msg - + StringTools.ENDLINE); + observer.updateText(msg + StringTools.ENDLINE); } } @@ -157,6 +156,5 @@ } for (ConsoleObserver observer : theInstance.observers) { - observer.errStream(errMsg - + StringTools.ENDLINE); + observer.errStream(errMsg + StringTools.ENDLINE); } } @@ -200,5 +198,6 @@ ** Sends a debug message to all observers containing the message that was - * passed to this function and adds an endline to the message. + * passed to this function and adds an {@link StringTools#ENDLINE} to the + * message. *
* @@ -211,6 +210,5 @@ } for (ConsoleObserver observer : theInstance.observers) { - observer.trace(traceMsg - + StringTools.ENDLINE); + observer.trace(traceMsg + StringTools.ENDLINE); } } Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/ConsoleObserver.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/console/ConsoleObserver.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/console/ConsoleObserver.java (revision 175) @@ -7,4 +7,5 @@ * * @author Steffen Herbold + * @version 1.0 */ public interface ConsoleObserver { Index: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/TextConsole.java =================================================================== --- trunk/JavaHelperLib/src/de/ugoe/cs/util/console/TextConsole.java (revision 122) +++ trunk/JavaHelperLib/src/de/ugoe/cs/util/console/TextConsole.java (revision 175) @@ -6,9 +6,9 @@ *
* Implements a simple console observer that prints normal text to
- * stdout, errors to stderr and reads from
- * stdin.
+ * {@code stdout}, errors to {@code stderr} and reads from {@code stdin}.
*
- * Prints messages to stdout.
+ * Prints messages to {@code stdout}.
*
- * Prints messages to stderr.
+ * Prints messages to {@code stderr}.
*
- * Prints the stackrace of an exception to stderr
+ * Prints the stacktrace of an exception to {@code stderr}.
*
- * Prints messages to stdout. These messages are only printed,
- * if the console is run in debug mode.
+ * Prints messages to {@code stdout}. These messages are only printed, if
+ * the console is run in debug mode.
*
stdin.
+ * {@code stdin}.
*
*
@@ -103,5 +103,5 @@
/**
*
- * Reads a new command from stdin.
+ * Reads a new command from {@code stdin}.
*
- * Implements a command to execute batchs of {@link Command}s, defined by batch - * file, to allow scripted executions. + * Command to execute a batch of {@link Command}s. The batch is defined as a + * text file, where each line defines one command. *
* * @author Steffen Herbold + * @version 1.0 */ public class CMDexec implements Command { - /** - *- * Executes a batch of {@link Command}s that are listed line by line in the - * given file. - *
- *
- * Usage: exec filename
- *