- * The attaching usually consist in the addition of commands in the console - * application. The attached command should be specific to the attachement - * (typically, the generic help command or the script command should not be - * added through this mechanism). - * - * @param application the application - * @throws InvalidCommandName if a command name is invalid for the - * application. */ - void attach(ICommandProvider application) throws InvalidCommandName; -} +/** + * gclc:fr.bigeon.gclc.ApplicationAttachement.java + * Created on: Apr 19, 2017 + */ +package fr.bigeon.gclc; + +/*- + * #%L + * Generic Command Ligne console + * %% + * Copyright (C) 2014 - 2018 bigeon.fr + * %% + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + * #L% + */ +import fr.bigeon.gclc.command.ICommandProvider; +import fr.bigeon.gclc.exception.InvalidCommandName; + +/** Represent a functionnality set that can be added to a console application. + * + * @author Emmanuel Bigeon */ +public interface ApplicationAttachement { + /** Attach this object to a console application. + *
+ * The attaching usually consist in the addition of commands in the console + * application. The attached command should be specific to the attachement + * (typically, the generic help command or the script command should not be + * added through this mechanism). + * + * @param application the application + * @throws InvalidCommandName if a command name is invalid for the + * application. */ + void attach(ICommandProvider application) throws InvalidCommandName; +} diff --git a/gclc/src/main/java/fr/bigeon/gclc/CommandRequestListener.java b/gclc/src/main/java/fr/bigeon/gclc/CommandRequestListener.java index 694cfb6..257e4ff 100644 --- a/gclc/src/main/java/fr/bigeon/gclc/CommandRequestListener.java +++ b/gclc/src/main/java/fr/bigeon/gclc/CommandRequestListener.java @@ -1,50 +1,49 @@ -/* - * Copyright Bigeon Emmanuel (2014) - * - * emmanuel@bigeon.fr - * - * This software is a computer program whose purpose is to - * provide a generic framework for console applications. - * - * This software is governed by the CeCILL license under French law and - * abiding by the rules of distribution of free software. You can use, - * modify and/or redistribute the software under the terms of the CeCILL - * license as circulated by CEA, CNRS and INRIA at the following URL - * "http://www.cecill.info". - * - * As a counterpart to the access to the source code and rights to copy, - * modify and redistribute granted by the license, users are provided only - * with a limited warranty and the software's author, the holder of the - * economic rights, and the successive licensors have only limited - * liability. - * - * In this respect, the user's attention is drawn to the risks associated - * with loading, using, modifying and/or developing or reproducing the - * software by the user in light of its specific status of free software, - * that may mean that it is complicated to manipulate, and that also - * therefore means that it is reserved for developers and experienced - * professionals having in-depth computer knowledge. Users are therefore - * encouraged to load and test the software's suitability as regards their - * requirements in conditions enabling the security of their systems and/or - * data to be ensured and, more generally, to use and operate it in the - * same conditions as regards security. - * - * The fact that you are presently reading this means that you have had - * knowledge of the CeCILL license and that you accept its terms. - */ -/** - * gclc:fr.bigeon.gclc.CommandRequestListener.java - * Created on: Mar 19, 2015 - */ -package fr.bigeon.gclc; - -/** Command Request Listeners are listeners that are notified before a command - * is executed by the ConsoleApplication. - * - * @author Emmanuel Bigeon */ -public interface CommandRequestListener { - /** Indicates that the given command was requested to the application. - * - * @param command the command */ - void commandRequest(String command); -} +/** + * gclc:fr.bigeon.gclc.CommandRequestListener.java + * Created on: Mar 19, 2015 + */ +package fr.bigeon.gclc; + +/*- + * #%L + * Generic Command Ligne console + * %% + * Copyright (C) 2014 - 2018 bigeon.fr + * %% + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + * #L% + */ +/** Command Request Listeners are listeners that are notified before a command + * is executed by the ConsoleApplication. + * + * @author Emmanuel Bigeon */ +public interface CommandRequestListener { + /** Indicates that the given command was requested to the application. + * + * @param command the command */ + void commandRequest(String command); +} diff --git a/gclc/src/main/java/fr/bigeon/gclc/ConsoleApplication.java b/gclc/src/main/java/fr/bigeon/gclc/ConsoleApplication.java index c0345f8..9c3ad4a 100644 --- a/gclc/src/main/java/fr/bigeon/gclc/ConsoleApplication.java +++ b/gclc/src/main/java/fr/bigeon/gclc/ConsoleApplication.java @@ -1,261 +1,294 @@ -/* - * Copyright Bigeon Emmanuel (2014) - * - * emmanuel@bigeon.fr - * - * This software is a computer program whose purpose is to - * provide a generic framework for console applications. - * - * This software is governed by the CeCILL license under French law and - * abiding by the rules of distribution of free software. You can use, - * modify and/or redistribute the software under the terms of the CeCILL - * license as circulated by CEA, CNRS and INRIA at the following URL - * "http://www.cecill.info". - * - * As a counterpart to the access to the source code and rights to copy, - * modify and redistribute granted by the license, users are provided only - * with a limited warranty and the software's author, the holder of the - * economic rights, and the successive licensors have only limited - * liability. - * - * In this respect, the user's attention is drawn to the risks associated - * with loading, using, modifying and/or developing or reproducing the - * software by the user in light of its specific status of free software, - * that may mean that it is complicated to manipulate, and that also - * therefore means that it is reserved for developers and experienced - * professionals having in-depth computer knowledge. Users are therefore - * encouraged to load and test the software's suitability as regards their - * requirements in conditions enabling the security of their systems and/or - * data to be ensured and, more generally, to use and operate it in the - * same conditions as regards security. - * - * The fact that you are presently reading this means that you have had - * knowledge of the CeCILL license and that you accept its terms. - */ -/** gclc:fr.bigeon.gclc.ConsoleApplication.java - * Created on: Sep 6, 2014 */ -package fr.bigeon.gclc; - -import java.io.IOException; -import java.io.InterruptedIOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; -import java.util.logging.Level; -import java.util.logging.Logger; - -import fr.bigeon.gclc.command.ICommand; -import fr.bigeon.gclc.command.ICommandProvider; -import fr.bigeon.gclc.command.SubedCommand; -import fr.bigeon.gclc.exception.CommandParsingException; -import fr.bigeon.gclc.exception.CommandRunException; -import fr.bigeon.gclc.exception.CommandRunExceptionType; -import fr.bigeon.gclc.exception.InvalidCommandName; -import fr.bigeon.gclc.i18n.Messages; -import fr.bigeon.gclc.manager.ConsoleInput; -import fr.bigeon.gclc.manager.ConsoleOutput; - -/** - * A {@link ConsoleApplication} is an application that require the user to input - * commands. - *
- * A typical use case is the following: - * - *
- * {@link ConsoleOutput} out = new {@link fr.bigeon.gclc.manager.StreamConsoleOutput StreamConsoleOutput}();
- * {@link ConsoleInput} in = new {@link fr.bigeon.gclc.manager.StreamConsoleInput StreamConsoleInput}();
- * {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
- * app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
- * app.{@link ConsoleApplication#start() start()};
- *
- *
- * That will launch in the console application that will display "welcome",
- * return a line and prompt the user for the command until he inputs the
- *
- * This method will split the command in its part and execute the command
- * with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
- *
- * @param cmd the command
- * @throws IOException if the command could not be parsed */
- public void interpretCommand(final String cmd) throws IOException {
- List
- * This consisting in getting the command, executing it and exiting
- * (restarting the loop). */
- private void runLoop() {
- try {
- final String cmd = in.prompt();
- if (cmd == null || cmd.isEmpty()) {
- return;
- }
- for (final CommandRequestListener listener : listeners) {
- listener.commandRequest(cmd);
- }
- interpretCommand(cmd);
- } catch (final InterruptedIOException e) {
- LOGGER.info(
- "Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
- LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
- e);
- } catch (final IOException e) {
- // The manager was closed
- running = false;
- LOGGER.warning(
- "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
- LOGGER.log(Level.FINE,
- "An exception caused the closing of the application", //$NON-NLS-1$
- e);
- }
- }
-
- /** Start the application. */
- public void start() {
- try {
- running = true;
- if (header != null) {
- out.println(header);
- }
- } catch (final IOException e) {
- // The manager was closed
- running = false;
- LOGGER.warning(
- "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
- LOGGER.log(Level.FINE,
- "An exception caused the closing of the application", //$NON-NLS-1$
- e);
- return;
- }
- do {
- runLoop();
- } while (running);
- if (footer != null) {
- try {
- out.println(footer);
- } catch (final IOException e) {
- // The manager was closed
- running = false;
- LOGGER.warning("Console manager alreaady closed."); //$NON-NLS-1$
- LOGGER.log(Level.FINE,
- "Exception raised by goodbye message printing... Application will still close.", //$NON-NLS-1$
- e);
- }
- }
- running = false;
- LOGGER.fine("Exiting application."); //$NON-NLS-1$
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/** gclc:fr.bigeon.gclc.ConsoleApplication.java
+ * Created on: Sep 6, 2014 */
+package fr.bigeon.gclc;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+import java.io.InterruptedIOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import fr.bigeon.gclc.command.ICommand;
+import fr.bigeon.gclc.command.ICommandProvider;
+import fr.bigeon.gclc.command.SubedCommand;
+import fr.bigeon.gclc.exception.CommandParsingException;
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.CommandRunExceptionType;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+import fr.bigeon.gclc.i18n.Messages;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/**
+ * A {@link ConsoleApplication} is an application that require the user to input
+ * commands.
+ *
+ * A typical use case is the following:
+ *
+ *
+ * That will launch in the console application that will display "welcome",
+ * return a line and prompt the user for the command until he inputs the
+ *
+ * This method will split the command in its part and execute the command
+ * with {@link #executeSub(ConsoleOutput, ConsoleInput, String, String...)}.
+ *
+ * @param cmd the command
+ * @throws IOException if the command could not be parsed */
+ public void interpretCommand(final String cmd) throws IOException {
+ List
+ * This consisting in getting the command, executing it and exiting
+ * (restarting the loop). */
+ private void runLoop() {
+ try {
+ final String cmd = in.prompt();
+ if (cmd == null || cmd.isEmpty()) {
+ return;
+ }
+ for (final CommandRequestListener listener : listeners) {
+ listener.commandRequest(cmd);
+ }
+ interpretCommand(cmd);
+ } catch (final InterruptedIOException e) {
+ LOGGER.info(
+ "Prompt interrupted. It is likely the application is closing."); //$NON-NLS-1$
+ LOGGER.log(Level.FINER, "Interruption of the prompt.", //$NON-NLS-1$
+ e);
+ } catch (final IOException e) {
+ // The manager was closed
+ running = false;
+ LOGGER.warning(
+ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
+ LOGGER.log(Level.FINE,
+ "An exception caused the closing of the application", //$NON-NLS-1$
+ e);
+ }
+ }
+
+ /** Start the application. */
+ public void start() {
+ try {
+ running = true;
+ if (header != null) {
+ out.println(header);
+ }
+ } catch (final IOException e) {
+ // The manager was closed
+ running = false;
+ LOGGER.warning(
+ "The console manager was closed. Closing the application as no one can reach it."); //$NON-NLS-1$
+ LOGGER.log(Level.FINE,
+ "An exception caused the closing of the application", //$NON-NLS-1$
+ e);
+ return;
+ }
+ do {
+ runLoop();
+ } while (running);
+ if (footer != null) {
+ try {
+ out.println(footer);
+ } catch (final IOException e) {
+ // The manager was closed
+ running = false;
+ LOGGER.warning("Console manager alreaady closed."); //$NON-NLS-1$
+ LOGGER.log(Level.FINE,
+ "Exception raised by goodbye message printing... Application will still close.", //$NON-NLS-1$
+ e);
+ }
+ }
+ running = false;
+ LOGGER.fine("Exiting application."); //$NON-NLS-1$
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/GCLCConstants.java b/gclc/src/main/java/fr/bigeon/gclc/GCLCConstants.java
index aa52fd8..9cbc005 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/GCLCConstants.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/GCLCConstants.java
@@ -1,143 +1,176 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.GCLCConstants.java
- * Created on: Jun 8, 2016
- */
-package fr.bigeon.gclc;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import fr.bigeon.gclc.exception.CommandParsingException;
-
-/** A Utility class for GCLC
- *
- * This class offers a method to split a line or arguments into the list of
- * arguments.
- *
- * @author Emmanuel Bigeon */
-public final class GCLCConstants {
-
- /** The escaping character. */
- private static final char ESCAPING_CHAR = getSystemEscapingChar();
-
- /** Hide utility class constructor. */
- private GCLCConstants() {
- // utility class
- }
-
- /** Get the end of a string argument.
- *
- * @param cmd the command to parse
- * @param startIndex the starting point of the parsing
- * @param index the index of the current position
- * @return the argument
- * @throws CommandParsingException if the end of string does not mark end of
- * command and is not followed by a space */
- private static String endOfString(final String cmd, final int startIndex,
- final int index) throws CommandParsingException {
- if (index < cmd.length() && cmd.charAt(index) != ' ') {
- throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
- }
- return cmd.substring(startIndex + 1, index - 1);
- }
-
- /** Get the excaping character.
- *
- * @return the escaping character */
- private static char getSystemEscapingChar() {
- return '\\';
- }
-
- /** Remove escaping characters from the string.
- *
- * @param arg the string to remove excaping character from
- * @return the string without escape character */
- private static String removeEscaped(final String arg) {
- final StringBuilder builder = new StringBuilder();
- int index = 0;
- int endIndex = arg.indexOf(ESCAPING_CHAR);
- while (endIndex != -1) {
- builder.append(arg.subSequence(index, endIndex));
- index = endIndex + 1;
- endIndex = arg.indexOf(ESCAPING_CHAR, index + 1);
- }
- builder.append(arg.substring(index));
- return builder.toString();
- }
-
- /** Splits a command in the diferrent arguments.
- *
- * @param cmd the command to split in its parts
- * @return the list of argument preceded by the command name
- * @throws CommandParsingException if the parsing of the command failed */
- public static List
+ * This class offers a method to split a line or arguments into the list of
+ * arguments.
+ *
+ * @author Emmanuel Bigeon */
+public final class GCLCConstants {
+
+ /** The escaping character. */
+ private static final char ESCAPING_CHAR = getSystemEscapingChar();
+
+ /** Hide utility class constructor. */
+ private GCLCConstants() {
+ // utility class
+ }
+
+ /** Get the end of a string argument.
+ *
+ * @param cmd the command to parse
+ * @param startIndex the starting point of the parsing
+ * @param index the index of the current position
+ * @return the argument
+ * @throws CommandParsingException if the end of string does not mark end of
+ * command and is not followed by a space */
+ private static String endOfString(final String cmd, final int startIndex,
+ final int index) throws CommandParsingException {
+ if (index < cmd.length() && cmd.charAt(index) != ' ') {
+ throw new CommandParsingException("Misplaced quote"); //$NON-NLS-1$
+ }
+ return cmd.substring(startIndex + 1, index - 1);
+ }
+
+ /** Get the excaping character.
+ *
+ * @return the escaping character */
+ private static char getSystemEscapingChar() {
+ return '\\';
+ }
+
+ /** Remove escaping characters from the string.
+ *
+ * @param arg the string to remove excaping character from
+ * @return the string without escape character */
+ private static String removeEscaped(final String arg) {
+ final StringBuilder builder = new StringBuilder();
+ int index = 0;
+ int endIndex = arg.indexOf(ESCAPING_CHAR);
+ while (endIndex != -1) {
+ builder.append(arg.subSequence(index, endIndex));
+ index = endIndex + 1;
+ endIndex = arg.indexOf(ESCAPING_CHAR, index + 1);
+ }
+ builder.append(arg.substring(index));
+ return builder.toString();
+ }
+
+ /** Splits a command in the diferrent arguments.
+ *
+ * @param cmd the command to split in its parts
+ * @return the list of argument preceded by the command name
+ * @throws CommandParsingException if the parsing of the command failed */
+ public static List
- * It is mandatory that it has a name and that name cannot start with minus
- * character or contain spaces.
- *
- * A command can be executed, with parameters that will be provided as an array
- * of strings.
- *
- * The help mechanism is doing the following:
- *
- * The default behavior for the brief message is to print the tip preceeded by a
- * couple of spaces.
- *
- * @author Emmanuel BIGEON */
-public abstract class Command implements ICommand {
-
- /** The linux end of line character. */
- private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
- /** The name of the command. */
- protected final String name;
-
- /** Create the command.
- *
- * @param name the command name */
- public Command(final String name) {
- super();
- this.name = name;
- }
-
- /** Get the brief part of the command help.
- *
- * This method may be overriden by implementations to improve the help
- * content. The default behavior is to print the tip.
- *
- * @return a brief description of the command
- * @see Command#help(ConsoleOutput, String...) */
- protected String brief() {
- return " " + tip(); //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
- @Override
- public final String getCommandName() {
- return name;
- }
-
- /** Prints a help content for this command to the console output.
- *
- * This help is following the given format:
- *
- *
- * It immediatly follows the {@link #usagePattern() usage pattern}.
- *
- * @return the detailed help (should end with end of line or be empty) */
- protected abstract String usageDetail();
-
- /** This prints the usage pattern for the command.
- *
- * It follows the brief introduction on the command ({@link #brief()})
- *
- * @return the usage pattern */
- protected String usagePattern() {
- return getCommandName();
- }
-}
+/**
+ * acide:fr.bigeon.acide.Command.java
+ * Created on: Jul 31, 2014
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** A command to execute.
+ *
+ * It is mandatory that it has a name and that name cannot start with minus
+ * character or contain spaces.
+ *
+ * A command can be executed, with parameters that will be provided as an array
+ * of strings.
+ *
+ * The help mechanism is doing the following:
+ *
+ * The default behavior for the brief message is to print the tip preceeded by a
+ * couple of spaces.
+ *
+ * @author Emmanuel BIGEON */
+public abstract class Command implements ICommand {
+
+ /** The linux end of line character. */
+ private static final String EOL_LINUX = "\n"; //$NON-NLS-1$
+ /** The name of the command. */
+ protected final String name;
+
+ /** Create the command.
+ *
+ * @param name the command name */
+ public Command(final String name) {
+ super();
+ this.name = name;
+ }
+
+ /** Get the brief part of the command help.
+ *
+ * This method may be overriden by implementations to improve the help
+ * content. The default behavior is to print the tip.
+ *
+ * @return a brief description of the command
+ * @see Command#help(ConsoleOutput, String...) */
+ protected String brief() {
+ return " " + tip(); //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
+ @Override
+ public final String getCommandName() {
+ return name;
+ }
+
+ /** Prints a help content for this command to the console output.
+ *
+ * This help is following the given format:
+ *
+ *
+ * It immediatly follows the {@link #usagePattern() usage pattern}.
+ *
+ * @return the detailed help (should end with end of line or be empty) */
+ protected abstract String usageDetail();
+
+ /** This prints the usage pattern for the command.
+ *
+ * It follows the brief introduction on the command ({@link #brief()})
+ *
+ * @return the usage pattern */
+ protected String usagePattern() {
+ return getCommandName();
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/CommandParameters.java b/gclc/src/main/java/fr/bigeon/gclc/command/CommandParameters.java
index be15f3b..32bccda 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/CommandParameters.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/CommandParameters.java
@@ -1,214 +1,213 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.CommandParameters.java
- * Created on: Dec 24, 2014
- */
-package fr.bigeon.gclc.command;
-
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import fr.bigeon.gclc.exception.CommandParsingException;
-
-/** An object representing a collection of parameters.
- *
- * It is used for defaulting values.
- *
- * @author Emmanuel BIGEON */
-public final class CommandParameters {
- /** Number of element for a string argument. */
- private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
- /** Boolean arguments. */
- private final Map
- * This method return 0 if the parsing was incorrect, or the number of
- * parsed elements.
- *
- * @param arg the argument
- * @param next the next element
- * @return the number of element read */
- private int parseArg(final String arg, final String next) {
- if (!arg.startsWith("-")) { //$NON-NLS-1$
- if (strict) {
- return 0;
- }
- additional.add(arg);
- return 1;
- }
- final String name = arg.substring(1);
- if (booleanArguments.containsKey(name)) {
- booleanArguments.put(name, Boolean.TRUE);
- return 1;
- }
- if (stringArguments.containsKey(name)) {
- return parseStringArg(name, next);
- }
- if (strict) {
- return 0;
- }
- additional.add(name);
- return 1;
- }
-
- /** Parse arguments.
- *
- * @param args the arguments to parse
- * @throws CommandParsingException if the arguments parsing failed */
- public void parseArgs(final String... args) throws CommandParsingException {
- int i = 0;
- while (i < args.length) {
- String next = null;
- if (i < args.length - 1) {
- next = args[i + 1];
- }
- final int p = parseArg(args[i], next);
- if (p == 0) {
- throw new CommandParsingException(
- "Invalid parameter " + args[i]); //$NON-NLS-1$
- }
- i += p;
- }
-
- }
-
- /** Add a string arg value.
- *
- * @param name the string arg name
- * @param next the string arg value
- * @return 2 or 0 if next is invalid */
- private int parseStringArg(final String name, final String next) {
- if (next == null) {
- return 0;
- }
- stringArguments.put(name, next);
- return STRINGARG_NUMBER_OF_ELEMENTS;
- }
-
- /** Set a boolean parameter value.
- *
- * @param string the key
- * @param value the value */
- public void set(final String string, final boolean value) {
- if (booleanArguments.containsKey(string)) {
- booleanArguments.put(string, Boolean.valueOf(value));
- }
- }
-
- /** Set a string parameter value.
- *
- * @param string the key
- * @param value the value */
- public void set(final String string, final String value) {
- if (stringArguments.containsKey(string)) {
- stringArguments.put(string, value);
- }
- }
-}
+/**
+ * gclc:fr.bigeon.gclc.command.CommandParameters.java
+ * Created on: Dec 24, 2014
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import fr.bigeon.gclc.exception.CommandParsingException;
+
+/** An object representing a collection of parameters.
+ *
+ * It is used for defaulting values.
+ *
+ * @author Emmanuel BIGEON */
+public final class CommandParameters {
+ /** Number of element for a string argument. */
+ private static final int STRINGARG_NUMBER_OF_ELEMENTS = 2;
+ /** Boolean arguments. */
+ private final Map
+ * This method return 0 if the parsing was incorrect, or the number of
+ * parsed elements.
+ *
+ * @param arg the argument
+ * @param next the next element
+ * @return the number of element read */
+ private int parseArg(final String arg, final String next) {
+ if (!arg.startsWith("-")) { //$NON-NLS-1$
+ if (strict) {
+ return 0;
+ }
+ additional.add(arg);
+ return 1;
+ }
+ final String name = arg.substring(1);
+ if (booleanArguments.containsKey(name)) {
+ booleanArguments.put(name, Boolean.TRUE);
+ return 1;
+ }
+ if (stringArguments.containsKey(name)) {
+ return parseStringArg(name, next);
+ }
+ if (strict) {
+ return 0;
+ }
+ additional.add(name);
+ return 1;
+ }
+
+ /** Parse arguments.
+ *
+ * @param args the arguments to parse
+ * @throws CommandParsingException if the arguments parsing failed */
+ public void parseArgs(final String... args) throws CommandParsingException {
+ int i = 0;
+ while (i < args.length) {
+ String next = null;
+ if (i < args.length - 1) {
+ next = args[i + 1];
+ }
+ final int p = parseArg(args[i], next);
+ if (p == 0) {
+ throw new CommandParsingException(
+ "Invalid parameter " + args[i]); //$NON-NLS-1$
+ }
+ i += p;
+ }
+
+ }
+
+ /** Add a string arg value.
+ *
+ * @param name the string arg name
+ * @param next the string arg value
+ * @return 2 or 0 if next is invalid */
+ private int parseStringArg(final String name, final String next) {
+ if (next == null) {
+ return 0;
+ }
+ stringArguments.put(name, next);
+ return STRINGARG_NUMBER_OF_ELEMENTS;
+ }
+
+ /** Set a boolean parameter value.
+ *
+ * @param string the key
+ * @param value the value */
+ public void set(final String string, final boolean value) {
+ if (booleanArguments.containsKey(string)) {
+ booleanArguments.put(string, Boolean.valueOf(value));
+ }
+ }
+
+ /** Set a string parameter value.
+ *
+ * @param string the key
+ * @param value the value */
+ public void set(final String string, final String value) {
+ if (stringArguments.containsKey(string)) {
+ stringArguments.put(string, value);
+ }
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/CommandProvider.java b/gclc/src/main/java/fr/bigeon/gclc/command/CommandProvider.java
index 9adfb54..0377260 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/CommandProvider.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/CommandProvider.java
@@ -1,125 +1,121 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/** acide:fr.bigeon.acide.CommandProvider.java
- * Created on: Aug 6, 2014 */
-package fr.bigeon.gclc.command;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.InvalidCommandName;
-import fr.bigeon.gclc.i18n.Messages;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** A command provider is a map of key word to command to execute.
- *
- * @author Emmanuel BIGEON */
-public class CommandProvider implements ICommandProvider {
- /** The minus character. */
- private static final String MINUS = "-"; //$NON-NLS-1$
- /** The space character. */
- private static final String SPACE = " "; //$NON-NLS-1$
- /** The commands map. */
- protected final List
- * This command will display the help of an other command
- *
- * @author Emmanuel BIGEON */
-public final class HelpExecutor extends Command {
-
- /** The command to execute the help of. */
- private final ICommand cmd;
-
- /** Create the help command.
- *
- * @param cmdName the command name
- * @param cmd the command to execute the help of */
- public HelpExecutor(final String cmdName,
- final ICommand cmd) {
- super(cmdName);
- this.cmd = cmd;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#brief() */
- @Override
- protected String brief() {
- if (cmd instanceof SubedCommand) {
- return " A command to get help for other commands"; //$NON-NLS-1$
- }
- return " A command to retrieve help for " + cmd.getCommandName(); //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
- * String[]) */
- @Override
- public void execute(final ConsoleOutput out, final ConsoleInput in,
- final String... args) throws CommandRunException {
- try {
- cmd.help(out, args);
- } catch (final IOException e) {
- throw new CommandRunException(CommandRunExceptionType.INTERACTION,
- "Console manager closed", e, this); //$NON-NLS-1$
- }
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#tip() */
- @Override
- public String tip() {
- return CLIPrompterMessages.getString("help.cmd.tip"); //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#usageDetail()
- */
- @Override
- protected String usageDetail() {
- return null;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#usagePattern() */
- @Override
- protected String usagePattern() {
- if (cmd instanceof SubedCommand) {
- return getCommandName() + "
+ * This command will display the help of an other command
+ *
+ * @author Emmanuel BIGEON */
+public final class HelpExecutor extends Command {
+
+ /** The command to execute the help of. */
+ private final ICommand cmd;
+
+ /** Create the help command.
+ *
+ * @param cmdName the command name
+ * @param cmd the command to execute the help of */
+ public HelpExecutor(final String cmdName,
+ final ICommand cmd) {
+ super(cmdName);
+ this.cmd = cmd;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#brief() */
+ @Override
+ protected String brief() {
+ if (cmd instanceof SubedCommand) {
+ return " A command to get help for other commands"; //$NON-NLS-1$
+ }
+ return " A command to retrieve help for " + cmd.getCommandName(); //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
+ * String[]) */
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ try {
+ cmd.help(out, args);
+ } catch (final IOException e) {
+ throw new CommandRunException(CommandRunExceptionType.INTERACTION,
+ "Console manager closed", e); //$NON-NLS-1$
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#tip() */
+ @Override
+ public String tip() {
+ return CLIPrompterMessages.getString("help.cmd.tip"); //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#usageDetail()
+ */
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#usagePattern() */
+ @Override
+ protected String usagePattern() {
+ if (cmd instanceof SubedCommand) {
+ return getCommandName() + "
- * This interface describe the contract of commands
- *
- * @author Emmanuel Bigeon */
-public interface ICommand {
-
- /** Execute the command on the given output and input.
- *
- * @param out the normal output
- * @param in the input
- * @param args the arguments
- * @throws CommandRunException if the command failed */
- void execute(ConsoleOutput out, ConsoleInput in,
- String... args) throws CommandRunException;
-
- /** Get teh command name.
- *
- * @return the command's name */
- String getCommandName();
-
- /** This prints the help associated to this command.
- *
- * @param output the output to print the data
- * @param args the arguments called with the help
- * @throws IOException if the manager was closed */
- void help(ConsoleOutput output, String... args) throws IOException;
-
- /** Get a tip (brief helping message) for the command.
- *
- * @return a tip on the command */
- String tip();
-
-}
\ No newline at end of file
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.ICommand.java
+ * Created on: May 31, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** The contract of commands.
+ *
+ * This interface describe the contract of commands
+ *
+ * @author Emmanuel Bigeon */
+public interface ICommand {
+
+ /** Execute the command on the given output and input.
+ *
+ * @param out the normal output
+ * @param in the input
+ * @param args the arguments
+ * @throws CommandRunException if the command failed */
+ void execute(ConsoleOutput out, ConsoleInput in,
+ String... args) throws CommandRunException;
+
+ /** Get teh command name.
+ *
+ * @return the command's name */
+ String getCommandName();
+
+ /** This prints the help associated to this command.
+ *
+ * @param output the output to print the data
+ * @param args the arguments called with the help
+ * @throws IOException if the manager was closed */
+ void help(ConsoleOutput output, String... args) throws IOException;
+
+ /** Get a tip (brief helping message) for the command.
+ *
+ * @return a tip on the command */
+ String tip();
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/ICommandProvider.java b/gclc/src/main/java/fr/bigeon/gclc/command/ICommandProvider.java
index 49f748e..bd3f8e3 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/ICommandProvider.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/ICommandProvider.java
@@ -1,84 +1,117 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/** gclc:fr.bigeon.gclc.command.ICommandProvider.java
- * Created on: Sep 6, 2014 */
-package fr.bigeon.gclc.command;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.InvalidCommandName;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** An ICommadProvider is a provider of commands that can register commands
- * under some keywords.
- *
- * @author Emmanuel BIGEON */
-public interface ICommandProvider {
-
- /** Adds a command to this provider, if no command was associated with the
- * given key.
- *
- * @param value the command to execute
- * @return if the command was added
- * @throws InvalidCommandName if the command name is invalid */
- boolean add(ICommand value) throws InvalidCommandName;
-
- /** Execute the command with the given name.
- *
- * If no command with this name is found, an error command is usually
- * executed. If there are several commands with the same name, the behavior
- * is unspecified. Depending on the implementation, it may run an error
- * command or prompt the user for a choice.
- *
- * @param out the output
- * @param in the input
- * @param command the name of the command the user wishes to execute
- * @param args the arguments for the command
- * @throws CommandRunException if the command failed to run */
- void executeSub(ConsoleOutput out, ConsoleInput in, String command,
- String... args) throws CommandRunException;
-
- /** Get the command with the given name.
- *
- * If no command with this name is found, an error command is usually
- * returned. If there are several commands with the same name, the behavior
- * is unspecified. Depending on the implementation, it may return an error
- * command or the first command with this name found.
- *
- * @param command the name of the command the user wishes to execute
- * @return the command to execute */
- ICommand get(String command);
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/** gclc:fr.bigeon.gclc.command.ICommandProvider.java
+ * Created on: Sep 6, 2014 */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** An ICommadProvider is a provider of commands that can register commands
+ * under some keywords.
+ *
+ * @author Emmanuel BIGEON */
+public interface ICommandProvider {
+
+ /** Adds a command to this provider, if no command was associated with the
+ * given key.
+ *
+ * @param value the command to execute
+ * @return if the command was added
+ * @throws InvalidCommandName if the command name is invalid */
+ boolean add(ICommand value) throws InvalidCommandName;
+
+ /** Execute the command with the given name.
+ *
+ * If no command with this name is found, an error command is usually
+ * executed. If there are several commands with the same name, the behavior
+ * is unspecified. Depending on the implementation, it may run an error
+ * command or prompt the user for a choice.
+ *
+ * @param out the output
+ * @param in the input
+ * @param command the name of the command the user wishes to execute
+ * @param args the arguments for the command
+ * @throws CommandRunException if the command failed to run */
+ void executeSub(ConsoleOutput out, ConsoleInput in, String command,
+ String... args) throws CommandRunException;
+
+ /** Get the command with the given name.
+ *
+ * If no command with this name is found, an error command is usually
+ * returned. If there are several commands with the same name, the behavior
+ * is unspecified. Depending on the implementation, it may return an error
+ * command or the first command with this name found.
+ *
+ * @param command the name of the command the user wishes to execute
+ * @return the command to execute */
+ ICommand get(String command);
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java b/gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java
index 1704877..2bc598e 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/ParametrizedCommand.java
@@ -1,160 +1,193 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.ParametrizedCommand.java
- * Created on: Dec 24, 2014
- */
-package fr.bigeon.gclc.command;
-
-import java.io.IOException;
-import java.util.Set;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.InvalidParameterException;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** A command relying on the {@link CommandParameters} to store parameters
- * values.
- *
- * @author Emmanuel BIGEON */
-public abstract class ParametrizedCommand extends Command {
-
- private final ParametrizedCommandData data;
-
- /** Create a parametrized command.
- *
- * Implementation are supposed to call the
- * {@link #addBooleanParameter(String)} and
- * {@link #addStringParameter(String, boolean)} method to set the
- * parameters.
- *
- * @param name the name */
- public ParametrizedCommand(final String name) {
- this(name, true);
- }
-
- /** Create a parametrized command.
- *
- * Implementation are supposed to call the
- * {@link #addBooleanParameter(String)} and
- * {@link #addStringParameter(String, boolean)} method to set the
- * parameters.
- *
- * @param name the name
- * @param strict if the arguments are restricted to the declared ones */
- public ParametrizedCommand(final String name, final boolean strict) {
- super(name);
- data = new ParametrizedCommandData(strict);
- }
-
- /** Add a boolean parameter to defined parmaters.
- *
- * @param flag the boolean flag
- * @throws InvalidParameterException if the parameter is already defined as
- * a string parameter */
- protected final void addBooleanParameter(final String flag) throws InvalidParameterException {
- data.addBooleanParameter(flag);
- }
-
- /** Add a string parameter to defined parmaters.
- *
- * @param flag the parameter flag
- * @param needed if the parameter's absence should cause an exception
- * @throws InvalidParameterException if the parameter is already defined as
- * a boolean parameter */
- protected final void addStringParameter(final String flag,
- final boolean needed) throws InvalidParameterException {
- data.addStringParameter(flag, needed);
- }
-
- /** Actually performs the execution after parsing the parameters.
- *
- * @param out the output
- * @param in the input
- * @param parameters the command parameters
- * @throws CommandRunException if the command failed */
- protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
- CommandParameters parameters) throws CommandRunException;
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */
- @Override
- public final void execute(final ConsoleOutput output,
- final ConsoleInput input,
- final String... args) throws CommandRunException {
- try {
- doExecute(output, input, data.getParameters(input, args));
- } catch (final IOException e) {
- throw new CommandRunException("Unable to get parameters", e, this);
- }
- }
-
- /** Retrieve the boolean parameters (aka flags).
- *
- * @return the set of boolean parameters */
- public final Set
+ * Implementation are supposed to call the
+ * {@link #addBooleanParameter(String)} and
+ * {@link #addStringParameter(String, boolean)} method to set the
+ * parameters.
+ *
+ * @param name the name */
+ public ParametrizedCommand(final String name) {
+ this(name, true);
+ }
+
+ /** Create a parametrized command.
+ *
+ * Implementation are supposed to call the
+ * {@link #addBooleanParameter(String)} and
+ * {@link #addStringParameter(String, boolean)} method to set the
+ * parameters.
+ *
+ * @param name the name
+ * @param strict if the arguments are restricted to the declared ones */
+ public ParametrizedCommand(final String name, final boolean strict) {
+ super(name);
+ data = new ParametrizedCommandData(strict);
+ }
+
+ /** Add a boolean parameter to defined parmaters.
+ *
+ * @param flag the boolean flag
+ * @throws InvalidParameterException if the parameter is already defined as
+ * a string parameter */
+ protected final void addBooleanParameter(final String flag) throws InvalidParameterException {
+ data.addBooleanParameter(flag);
+ }
+
+ /** Add a string parameter to defined parmaters.
+ *
+ * @param flag the parameter flag
+ * @param needed if the parameter's absence should cause an exception
+ * @throws InvalidParameterException if the parameter is already defined as
+ * a boolean parameter */
+ protected final void addStringParameter(final String flag,
+ final boolean needed) throws InvalidParameterException {
+ data.addStringParameter(flag, needed);
+ }
+
+ /** Actually performs the execution after parsing the parameters.
+ *
+ * @param out the output
+ * @param in the input
+ * @param parameters the command parameters
+ * @throws CommandRunException if the command failed */
+ protected abstract void doExecute(ConsoleOutput out, ConsoleInput in,
+ CommandParameters parameters) throws CommandRunException;
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#execute(java.lang.String[]) */
+ @Override
+ public final void execute(final ConsoleOutput output,
+ final ConsoleInput input,
+ final String... args) throws CommandRunException {
+ try {
+ doExecute(output, input, data.getParameters(input, args));
+ } catch (final IOException e) {
+ throw new CommandRunException("Unable to get parameters", e);
+ }
+ }
+
+ /** Retrieve the boolean parameters (aka flags).
+ *
+ * @return the set of boolean parameters */
+ public final Set
- * This method prompts the user to fill the needed parameters.
- *
- * @param input the input to prompt through
- * @param parameters the parameter list to complete
- * @param toProvide the parameters to ask for
- * @throws IOException if the manager was closed */
- private final static void fillParameters(final ConsoleInput input,
- final List
+ * This method prompts the user to fill the needed parameters.
+ *
+ * @param input the input to prompt through
+ * @param parameters the parameter list to complete
+ * @param toProvide the parameters to ask for
+ * @throws IOException if the manager was closed */
+ private final static void fillParameters(final ConsoleInput input,
+ final List
- * A subed command is a command that can execute sub commands depending on the
- * first argument.
- *
- * @author Emmanuel BIGEON */
-public final class SubedCommand extends CommandProvider implements ICommand {
-
- /** The tab character. */
- private static final String TAB = "\t"; //$NON-NLS-1$
- /** The command to execute when this command is called with no sub
- * arguments.
- *
- * This may be null, in which case the command should have arguments. */
- private final ICommand noArgCommand;
- /** A tip on this command. */
- private final String tip;
- /** The name of the command. */
- private final String name;
-
- /** Create the command that defines sub commands.
- *
- * @param name the name of the command */
- public SubedCommand(final String name) {
- super();
- this.name = name;
- noArgCommand = null;
- tip = null;
- }
-
- /** Create the command that defines sub commands.
- *
- * @param name the name of the command
- * @param noArgCommand the command to execute when no extra parameter are
- * provided */
- public SubedCommand(final String name, final ICommand noArgCommand) {
- super();
- this.name = name;
- this.noArgCommand = noArgCommand;
- tip = null;
- }
-
- /** Create the command that defines sub commands.
- *
- * @param name the name of the command
- * @param noArgCommand the command to execute
- * @param tip the help tip associated */
- public SubedCommand(final String name, final ICommand noArgCommand,
- final String tip) {
- super();
- this.name = name;
- this.noArgCommand = noArgCommand;
- this.tip = tip;
- }
-
- /** Create the command that defines sub commands.
- *
- * @param name the name of the command
- * @param tip the help tip associated */
- public SubedCommand(final String name, final String tip) {
- super();
- this.name = name;
- noArgCommand = null;
- this.tip = tip;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
- @Override
- public void execute(final ConsoleOutput output, final ConsoleInput input,
- final String... args) throws CommandRunException {
- if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
- if (noArgCommand != null) {
- noArgCommand.execute(output, input, args);
- } else {
- throw new CommandRunException("Unrecognized command", this); //$NON-NLS-1$
- }
- } else {
-
- try {
- executeSub(output, input, args[0],
- Arrays.copyOfRange(args, 1, args.length));
- } catch (final CommandRunException e) {
- if (e.getSource() != null) {
- throw e;
- }
- throw new CommandRunException(CommandRunExceptionType.USAGE,
- e.getLocalizedMessage(), e, this);
- }
- }
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
- @Override
- public String getCommandName() {
- return name;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#help() */
- @Override
- public void help(final ConsoleOutput manager,
- final String... args) throws IOException {
- if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
- // Specific
- final ICommand c = get(args[0]);
- if (c != null) {
- c.help(manager, Arrays.copyOfRange(args, 1, args.length));
- } else {
- manager.println("No command "+Arrays.toString(args));
- }
- } else {
- // Generic
- if (noArgCommand != null && noArgCommand.tip() != null) {
- manager.println(TAB + noArgCommand.tip());
- }
- for (final ICommand cmd : commands) {
- if (cmd.tip() == null) {
- manager.println(TAB + cmd.getCommandName());
- } else {
- manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
- cmd.tip());
- }
- }
- }
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#tip() */
- @Override
- public String tip() {
- return tip;
- }
-
- /* (non-Javadoc)
- * @see java.lang.Object#toString() */
- @Override
- public String toString() {
- return "SubedCommand " + super.toString(); //$NON-NLS-1$
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/** gclc:fr.bigeon.gclc.command.SubedCommand.java
+ * Created on: Sep 6, 2014 */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+import java.util.Arrays;
+
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.CommandRunExceptionType;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/**
+ *
+ * A subed command is a command that can execute sub commands depending on the
+ * first argument.
+ *
+ * @author Emmanuel BIGEON */
+public final class SubedCommand extends CommandProvider implements ICommand {
+
+ /** The tab character. */
+ private static final String TAB = "\t"; //$NON-NLS-1$
+ /** The command to execute when this command is called with no sub
+ * arguments.
+ *
+ * This may be null, in which case the command should have arguments. */
+ private final ICommand noArgCommand;
+ /** A tip on this command. */
+ private final String tip;
+ /** The name of the command. */
+ private final String name;
+
+ /** Create the command that defines sub commands.
+ *
+ * @param name the name of the command */
+ public SubedCommand(final String name) {
+ super();
+ this.name = name;
+ noArgCommand = null;
+ tip = null;
+ }
+
+ /** Create the command that defines sub commands.
+ *
+ * @param name the name of the command
+ * @param noArgCommand the command to execute when no extra parameter are
+ * provided */
+ public SubedCommand(final String name, final ICommand noArgCommand) {
+ super();
+ this.name = name;
+ this.noArgCommand = noArgCommand;
+ tip = null;
+ }
+
+ /** Create the command that defines sub commands.
+ *
+ * @param name the name of the command
+ * @param noArgCommand the command to execute
+ * @param tip the help tip associated */
+ public SubedCommand(final String name, final ICommand noArgCommand,
+ final String tip) {
+ super();
+ this.name = name;
+ this.noArgCommand = noArgCommand;
+ this.tip = tip;
+ }
+
+ /** Create the command that defines sub commands.
+ *
+ * @param name the name of the command
+ * @param tip the help tip associated */
+ public SubedCommand(final String name, final String tip) {
+ super();
+ this.name = name;
+ noArgCommand = null;
+ this.tip = tip;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.acide.Command#execute(java.lang.String[]) */
+ @Override
+ public void execute(final ConsoleOutput output, final ConsoleInput input,
+ final String... args) throws CommandRunException {
+ if (args.length == 0 || args[0].startsWith("-")) { //$NON-NLS-1$
+ if (noArgCommand != null) {
+ noArgCommand.execute(output, input, args);
+ } else {
+ throw new CommandRunException("Unrecognized command"); //$NON-NLS-1$
+ }
+ } else {
+
+ try {
+ executeSub(output, input, args[0],
+ Arrays.copyOfRange(args, 1, args.length));
+ } catch (final CommandRunException e) {
+ throw new CommandRunException(CommandRunExceptionType.USAGE,
+ e.getLocalizedMessage(), e);
+ }
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
+ @Override
+ public String getCommandName() {
+ return name;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#help() */
+ @Override
+ public void help(final ConsoleOutput manager,
+ final String... args) throws IOException {
+ if (args.length != 0 && !args[0].startsWith("-")) { //$NON-NLS-1$
+ // Specific
+ final ICommand c = get(args[0]);
+ if (c != null) {
+ c.help(manager, Arrays.copyOfRange(args, 1, args.length));
+ } else {
+ manager.println("No command "+Arrays.toString(args));
+ }
+ } else {
+ // Generic
+ if (noArgCommand != null && noArgCommand.tip() != null) {
+ manager.println(TAB + noArgCommand.tip());
+ }
+ for (final ICommand cmd : commands) {
+ if (cmd.tip() == null) {
+ manager.println(TAB + cmd.getCommandName());
+ } else {
+ manager.println(TAB + cmd.getCommandName() + ": " + //$NON-NLS-1$
+ cmd.tip());
+ }
+ }
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#tip() */
+ @Override
+ public String tip() {
+ return tip;
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Object#toString() */
+ @Override
+ public String toString() {
+ return "SubedCommand " + super.toString(); //$NON-NLS-1$
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/ExitCommand.java b/gclc/src/main/java/fr/bigeon/gclc/command/base/ExitCommand.java
similarity index 66%
rename from gclc/src/main/java/fr/bigeon/gclc/command/ExitCommand.java
rename to gclc/src/main/java/fr/bigeon/gclc/command/base/ExitCommand.java
index cd14335..48a9658 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/ExitCommand.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/base/ExitCommand.java
@@ -1,101 +1,135 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.ExitCommand.java
- * Created on: Jun 8, 2016
- */
-package fr.bigeon.gclc.command;
-
-import java.io.IOException;
-
-import fr.bigeon.gclc.ConsoleApplication;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-import fr.bigeon.gclc.prompt.CLIPrompterMessages;
-
-/** A command to exit a {@link ConsoleApplication}.
- *
- * @author Emmanuel BIGEON */
-public class ExitCommand implements ICommand {
- /** The exit command manual message key. */
- private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
- /** The tip of the exit command. */
- private static final String EXIT = "exit.tip"; //$NON-NLS-1$
- /** The application that will be exited when this command runs. */
- private final ConsoleApplication app;
- /** The exit command name. */
- private final String name;
-
- /** Create the exiting command.
- *
- * @param name the name of the command
- * @param app the application to exit */
- public ExitCommand(final String name, final ConsoleApplication app) {
- this.name = name;
- this.app = app;
- }
-
- /** The actions to take before exiting.
- *
- * This method is intended to be overriden by sub classes. */
- protected void beforeExit() {
- // Do nothing by default
- }
-
- @Override
- public final void execute(final ConsoleOutput output,
- final ConsoleInput input, final String... args) {
- beforeExit();
- app.exit();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
- @Override
- public final String getCommandName() {
- return name;
- }
-
- @Override
- public final void help(final ConsoleOutput manager,
- final String... args) throws IOException {
- manager.println(
- CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
- }
- @Override
- public final String tip() {
- return CLIPrompterMessages.getString(EXIT);
- }
-}
\ No newline at end of file
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.ExitCommand.java
+ * Created on: Jun 8, 2016
+ */
+package fr.bigeon.gclc.command.base;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+
+import fr.bigeon.gclc.ConsoleApplication;
+import fr.bigeon.gclc.command.ICommand;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+import fr.bigeon.gclc.prompt.CLIPrompterMessages;
+
+/** A command to exit a {@link ConsoleApplication}.
+ *
+ * @author Emmanuel BIGEON */
+public final class ExitCommand implements ICommand {
+ /** The exit command manual message key. */
+ private static final String EXIT_MAN = "exit.man"; //$NON-NLS-1$
+ /** The tip of the exit command. */
+ private static final String EXIT = "exit.tip"; //$NON-NLS-1$
+ /** The application that will be exited when this command runs. */
+ private final ConsoleApplication app;
+ /** The exit command name. */
+ private final String name;
+
+ /** Create the exiting command.
+ *
+ * @param name the name of the command
+ * @param app the application to exit */
+ public ExitCommand(final String name, final ConsoleApplication app) {
+ this.name = name;
+ this.app = app;
+ }
+
+ /** The actions to take before exiting.
+ *
+ * This method is intended to be overriden by sub classes. */
+ protected void beforeExit() {
+ // Do nothing by default
+ }
+
+ @Override
+ public final void execute(final ConsoleOutput output,
+ final ConsoleInput input, final String... args) {
+ beforeExit();
+ app.exit();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
+ @Override
+ public final String getCommandName() {
+ return name;
+ }
+
+ @Override
+ public final void help(final ConsoleOutput manager,
+ final String... args) throws IOException {
+ manager.println(
+ CLIPrompterMessages.getString(EXIT_MAN, (Object[]) args));
+ }
+ @Override
+ public final String tip() {
+ return CLIPrompterMessages.getString(EXIT);
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/MockCommand.java b/gclc/src/main/java/fr/bigeon/gclc/command/base/MockCommand.java
similarity index 63%
rename from gclc/src/main/java/fr/bigeon/gclc/command/MockCommand.java
rename to gclc/src/main/java/fr/bigeon/gclc/command/base/MockCommand.java
index c36c895..82cdca8 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/MockCommand.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/base/MockCommand.java
@@ -1,93 +1,127 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.MockCommand.java
- * Created on: Nov 18, 2016
- */
-package fr.bigeon.gclc.command;
-
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** This implement a command that does nothing.
- *
- * This class is intended for testing purpose only.
- *
- * @author Emmanuel Bigeon */
-public final class MockCommand implements ICommand {
-
- /** The command name. */
- private final String name;
-
- /** Create the command.
- *
- * @param name the command name */
- public MockCommand(final String name) {
- this.name = name;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
- * String[]) */
- @Override
- public void execute(final ConsoleOutput out, final ConsoleInput in,
- final String... args) {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
- @Override
- public String getCommandName() {
- return name;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#help(fr.bigeon.gclc.manager.
- * ConsoleManager, java.lang.String[]) */
- @Override
- public void help(final ConsoleOutput manager,
- final String... args) {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#tip() */
- @Override
- public String tip() {
- return null;
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.MockCommand.java
+ * Created on: Nov 18, 2016
+ */
+package fr.bigeon.gclc.command.base;
+
+import fr.bigeon.gclc.command.ICommand;
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** This implement a command that does nothing.
+ *
+ * This class is intended for testing purpose only.
+ *
+ * @author Emmanuel Bigeon */
+public final class MockCommand implements ICommand {
+
+ /** The command name. */
+ private final String name;
+
+ /** Create the command.
+ *
+ * @param name the command name */
+ public MockCommand(final String name) {
+ this.name = name;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(ConsoleOutput, ConsoleInput,
+ * String[]) */
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#getCommandName() */
+ @Override
+ public String getCommandName() {
+ return name;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#help(fr.bigeon.gclc.manager.
+ * ConsoleManager, java.lang.String[]) */
+ @Override
+ public void help(final ConsoleOutput manager,
+ final String... args) {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#tip() */
+ @Override
+ public String tip() {
+ return null;
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/command/ScriptExecution.java b/gclc/src/main/java/fr/bigeon/gclc/command/base/ScriptExecution.java
similarity index 78%
rename from gclc/src/main/java/fr/bigeon/gclc/command/ScriptExecution.java
rename to gclc/src/main/java/fr/bigeon/gclc/command/base/ScriptExecution.java
index 6d6788b..a4b3943 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/command/ScriptExecution.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/command/base/ScriptExecution.java
@@ -1,217 +1,246 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.ScriptExecution.java
- * Created on: Jun 12, 2016
- */
-package fr.bigeon.gclc.command;
-
-import java.io.BufferedReader;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.nio.charset.Charset;
-import java.text.MessageFormat;
-import java.util.Arrays;
-import java.util.List;
-
-import fr.bigeon.gclc.ConsoleApplication;
-import fr.bigeon.gclc.GCLCConstants;
-import fr.bigeon.gclc.exception.CommandParsingException;
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.CommandRunExceptionType;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** A command that will launch a series of command from a file.
- *
- * This command will read a file and execute each non empty non commented line
- * as a command of the application.
- *
- * @author Emmanuel Bigeon */
-public final class ScriptExecution extends Command {
-
- /** The tab character. */
- private static final String TAB = "\t"; //$NON-NLS-1$
- /** the space character. */
- private static final String SPACE = " "; //$NON-NLS-1$
- /** The application. */
- private final ConsoleApplication application;
- /** The commenting prefix. */
- private final String commentPrefix;
- /** The charset for files. */
- private final Charset charset;
-
- /** Create the script command.
- *
- * @param name the name of the command
- * @param application the application
- * @param commentPrefix the comment prefix in the script files
- * @param charset the charset to use for files */
- public ScriptExecution(final String name, final ConsoleApplication application,
- final String commentPrefix, final Charset charset) {
- super(name);
- this.application = application;
- this.commentPrefix = commentPrefix;
- this.charset = charset;
- }
-
- /** Check the arguments.
- *
- * @param args the arguments
- * @throws CommandRunException if the arguments were not the ones
- * expected */
- private void checkArgs(final String[] args) throws CommandRunException {
- if (args.length == 0) {
- throw new CommandRunException(CommandRunExceptionType.USAGE,
- "Expecting a file", this); //$NON-NLS-1$
- }
- }
-
-
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
- @Override
- public void execute(final ConsoleOutput out, final ConsoleInput in,
- final String... args) throws CommandRunException {
- checkArgs(args);
- final String scriptFile = args[0];
- final String[] params = Arrays.copyOfRange(args, 1, args.length);
- String cmd;
- int lineNo = -1;
- try (InputStreamReader fReader = new InputStreamReader(
- new FileInputStream(scriptFile), charset);
- BufferedReader reader = new BufferedReader(fReader)) {
- while ((cmd = reader.readLine()) != null) {
- lineNo++;
- final String cmdLine = readCommandLine(cmd, params);
- if (cmdLine == null) {
- continue;
- }
- final List
+ * This command will read a file and execute each non empty non commented line
+ * as a command of the application.
+ *
+ * @author Emmanuel Bigeon */
+public final class ScriptExecution extends Command {
+
+ /** The tab character. */
+ private static final String TAB = "\t"; //$NON-NLS-1$
+ /** the space character. */
+ private static final String SPACE = " "; //$NON-NLS-1$
+ /** The application. */
+ private final ConsoleApplication application;
+ /** The commenting prefix. */
+ private final String commentPrefix;
+ /** The charset for files. */
+ private final Charset charset;
+
+ /** Create the script command.
+ *
+ * @param name the name of the command
+ * @param application the application
+ * @param commentPrefix the comment prefix in the script files
+ * @param charset the charset to use for files */
+ public ScriptExecution(final String name, final ConsoleApplication application,
+ final String commentPrefix, final Charset charset) {
+ super(name);
+ this.application = application;
+ this.commentPrefix = commentPrefix;
+ this.charset = charset;
+ }
+
+ /** Check the arguments.
+ *
+ * @param args the arguments
+ * @throws CommandRunException if the arguments were not the ones
+ * expected */
+ private static void checkArgs(final String[] args) throws CommandRunException {
+ if (args.length == 0) {
+ throw new CommandRunException(CommandRunExceptionType.USAGE,
+ "Expecting a file"); //$NON-NLS-1$
+ }
+ }
+
+
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(java.lang.String[]) */
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ checkArgs(args);
+ final String scriptFile = args[0];
+ final String[] params = Arrays.copyOfRange(args, 1, args.length);
+ String cmd;
+ int lineNo = -1;
+ try (InputStreamReader fReader = new InputStreamReader(
+ new FileInputStream(scriptFile), charset);
+ BufferedReader reader = new BufferedReader(fReader)) {
+ while ((cmd = reader.readLine()) != null) {
+ lineNo++;
+ final String cmdLine = readCommandLine(cmd, params);
+ if (cmdLine == null) {
+ continue;
+ }
+ final List
- * There are some implementations, such as the
- * {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a
- * predefined set of flags and option taking a string as value, the
- * {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in
- * a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for
- * help display of other commands and the
- *
- * @author Emmanuel BIGEON */
-package fr.bigeon.gclc.command;
\ No newline at end of file
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+
+/** gclc:fr.bigeon.gclc.command.package-info.java
+ * Created on: Sep 6, 2014 */
+/** This package groups elements related to
+ * {@link fr.bigeon.gclc.command.ICommand}
+ *
+ * There are some implementations, such as the
+ * {@link fr.bigeon.gclc.command.ParametrizedCommand} for commands with a
+ * predefined set of flags and option taking a string as value, the
+ * {@link fr.bigeon.gclc.command.SubedCommand} for a command that is declined in
+ * a set of sub commands, the {@link fr.bigeon.gclc.command.HelpExecutor} for
+ * help display of other commands and the
+ *
+ * @author Emmanuel BIGEON */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
diff --git a/gclc/src/main/java/fr/bigeon/gclc/exception/CommandParsingException.java b/gclc/src/main/java/fr/bigeon/gclc/exception/CommandParsingException.java
index 3f46cd7..6da820f 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/exception/CommandParsingException.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/exception/CommandParsingException.java
@@ -1,71 +1,104 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.exception.CommandParsingException.java
- * Created on: Jun 1, 2016
- */
-package fr.bigeon.gclc.exception;
-
-/** An exception raised during command parsing.
- *
- * @author Emmanuel Bigeon */
-public class CommandParsingException extends Exception {
-
- /** svuid. */
- private static final long serialVersionUID = 1L;
-
- /** Create the exception with a message.
- *
- * @param message the message */
- public CommandParsingException(final String message) {
- super(message);
- }
-
- /** Create the exception with a message and a cause.
- *
- * @param message the message
- * @param cause the cause */
- public CommandParsingException(final String message, final Throwable cause) {
- super(message, cause);
- }
-
- /** Create the exception with a message.
- *
- * @param cause the cause */
- public CommandParsingException(final Throwable cause) {
- super(cause);
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.exception.CommandParsingException.java
+ * Created on: Jun 1, 2016
+ */
+package fr.bigeon.gclc.exception;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+/** An exception raised during command parsing.
+ *
+ * @author Emmanuel Bigeon */
+public class CommandParsingException extends Exception {
+
+ /** svuid. */
+ private static final long serialVersionUID = 1L;
+
+ /** Create the exception with a message.
+ *
+ * @param message the message */
+ public CommandParsingException(final String message) {
+ super(message);
+ }
+
+ /** Create the exception with a message and a cause.
+ *
+ * @param message the message
+ * @param cause the cause */
+ public CommandParsingException(final String message, final Throwable cause) {
+ super(message, cause);
+ }
+
+ /** Create the exception with a message.
+ *
+ * @param cause the cause */
+ public CommandParsingException(final Throwable cause) {
+ super(cause);
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunException.java b/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunException.java
index 59dcec9..a6ff30e 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunException.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunException.java
@@ -1,130 +1,142 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.exception.CommandRunException.java
- * Created on: Feb 10, 2015
- */
-package fr.bigeon.gclc.exception;
-
-import fr.bigeon.gclc.command.ICommand;
-
-/** An exception thrown when a command failed to run correctly.
- *
- * @author Emmanuel BIGEON */
-public final class CommandRunException extends Exception {
-
- /** the SVUID. */
- private static final long serialVersionUID = 1L;
-
- /** The type of run exception. */
- private final CommandRunExceptionType type;
- /** The command that caused the error. */
- private transient ICommand source;
-
- /** Create the exception.
- *
- * @param type the type of exception
- * @param message the message
- * @param source the source */
- public CommandRunException(final CommandRunExceptionType type,
- final String message, final ICommand source) {
- super(message);
- this.type = type;
- this.source = source;
- }
-
- /** Create the exception with a cause.
- *
- * @param type the type of exception
- * @param message a message
- * @param cause the cause
- * @param source the source */
- public CommandRunException(final CommandRunExceptionType type,
- final String message, final Throwable cause,
- final ICommand source) {
- super(message, cause);
- this.type = type;
- this.source = source;
- }
-
- /** Create the exception with type
- * {@link CommandRunExceptionType#EXECUTION}.
- *
- * @param message a message
- * @param source the source */
- public CommandRunException(final String message, final ICommand source) {
- super(message);
- type = CommandRunExceptionType.EXECUTION;
- this.source = source;
- }
-
- /** Create the exception with type {@link CommandRunExceptionType#EXECUTION}
- * and a cause.
- *
- * @param message a message
- * @param cause the cause
- * @param source the source */
- public CommandRunException(final String message, final Throwable cause,
- final ICommand source) {
- super(message, cause);
- type = CommandRunExceptionType.EXECUTION;
- this.source = source;
- }
-
- /* (non-Javadoc)
- * @see java.lang.Throwable#getLocalizedMessage() */
- @Override
- public String getLocalizedMessage() {
- if (getCause() != null) {
- return super.getLocalizedMessage() + ": " + //$NON-NLS-1$
- getCause().getLocalizedMessage();
- }
- return super.getLocalizedMessage();
- }
-
- /** Get the exception raising command.
- *
- * @return the source */
- public ICommand getSource() {
- return source;
- }
-
- /** Get the exception type.
- *
- * @return the type */
- public CommandRunExceptionType getType() {
- return type;
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.exception.CommandRunException.java
+ * Created on: Feb 10, 2015
+ */
+package fr.bigeon.gclc.exception;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 Bigeon
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+
+/** An exception thrown when a command failed to run correctly.
+ *
+ * @author Emmanuel BIGEON */
+public final class CommandRunException extends Exception {
+
+ /** the SVUID. */
+ private static final long serialVersionUID = 1L;
+
+ /** The type of run exception. */
+ private final CommandRunExceptionType type;
+
+ /** Create the exception.
+ *
+ * @param type the type of exception
+ * @param message the message */
+ public CommandRunException(final CommandRunExceptionType type,
+ final String message) {
+ super(message);
+ this.type = type;
+ }
+
+ /** Create the exception with a cause.
+ *
+ * @param type the type of exception
+ * @param message a message
+ * @param cause the cause */
+ public CommandRunException(final CommandRunExceptionType type,
+ final String message, final Throwable cause) {
+ super(message, cause);
+ this.type = type;
+ }
+
+ /** Create the exception with type {@link CommandRunExceptionType#EXECUTION}.
+ *
+ * @param message a message */
+ public CommandRunException(final String message) {
+ super(message);
+ type = CommandRunExceptionType.EXECUTION;
+ }
+
+ /** Create the exception with type {@link CommandRunExceptionType#EXECUTION} and
+ * a cause.
+ *
+ * @param message a message
+ * @param cause the cause */
+ public CommandRunException(final String message, final Throwable cause) {
+ super(message, cause);
+ type = CommandRunExceptionType.EXECUTION;
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Throwable#getLocalizedMessage() */
+ @Override
+ public String getLocalizedMessage() {
+ if (getCause() != null) {
+ return super.getLocalizedMessage() + ": " + //$NON-NLS-1$
+ getCause().getLocalizedMessage();
+ }
+ return super.getLocalizedMessage();
+ }
+
+ /** Get the exception type.
+ *
+ * @return the type */
+ public CommandRunExceptionType getType() {
+ return type;
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunExceptionType.java b/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunExceptionType.java
index 3487d5f..bd25616 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunExceptionType.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/exception/CommandRunExceptionType.java
@@ -1,51 +1,84 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.exception.CommandRunExceptionType.java
- * Created on: Jun 12, 2016
- */
-package fr.bigeon.gclc.exception;
-
-/** The command run exception possible types.
- *
- * @author Emmanuel Bigeon */
-public enum CommandRunExceptionType {
- /** Type of exception due to a wrong usage. */
- USAGE,
- /** Type of exception due to a problem in execution. */
- EXECUTION,
- /** Type of exception due to the impossibility to interact with user. */
- INTERACTION;
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.exception.CommandRunExceptionType.java
+ * Created on: Jun 12, 2016
+ */
+package fr.bigeon.gclc.exception;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+/** The command run exception possible types.
+ *
+ * @author Emmanuel Bigeon */
+public enum CommandRunExceptionType {
+ /** Type of exception due to a wrong usage. */
+ USAGE,
+ /** Type of exception due to a problem in execution. */
+ EXECUTION,
+ /** Type of exception due to the impossibility to interact with user. */
+ INTERACTION;
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidCommandName.java b/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidCommandName.java
index fb02729..0ee7690 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidCommandName.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidCommandName.java
@@ -1,77 +1,110 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.exception.InvalidCommandName.java
- * Created on: Dec 23, 2014
- */
-package fr.bigeon.gclc.exception;
-
-/** Exception sent from the application when a command is added but the name of
- * the command is already used.
- *
- * @author Emmanuel BIGEON */
-public class InvalidCommandName extends Exception {
-
- /** the SVUID. */
- private static final long serialVersionUID = 1L;
-
- /** Default constructor. */
- public InvalidCommandName() {
- super();
- }
-
- /** Create the exception with a message.
- *
- * @param message the message */
- public InvalidCommandName(final String message) {
- super(message);
- }
-
- /** Create the exception with a message and a cause.
- *
- * @param message the message
- * @param cause the cause */
- public InvalidCommandName(final String message, final Throwable cause) {
- super(message, cause);
- }
-
- /** Create the exception with a cause.
- *
- * @param cause the cause */
- public InvalidCommandName(final Throwable cause) {
- super(cause);
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.exception.InvalidCommandName.java
+ * Created on: Dec 23, 2014
+ */
+package fr.bigeon.gclc.exception;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+/** Exception sent from the application when a command is added but the name of
+ * the command is already used.
+ *
+ * @author Emmanuel BIGEON */
+public class InvalidCommandName extends Exception {
+
+ /** the SVUID. */
+ private static final long serialVersionUID = 1L;
+
+ /** Default constructor. */
+ public InvalidCommandName() {
+ super();
+ }
+
+ /** Create the exception with a message.
+ *
+ * @param message the message */
+ public InvalidCommandName(final String message) {
+ super(message);
+ }
+
+ /** Create the exception with a message and a cause.
+ *
+ * @param message the message
+ * @param cause the cause */
+ public InvalidCommandName(final String message, final Throwable cause) {
+ super(message, cause);
+ }
+
+ /** Create the exception with a cause.
+ *
+ * @param cause the cause */
+ public InvalidCommandName(final Throwable cause) {
+ super(cause);
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidParameterException.java b/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidParameterException.java
index fe9c6c1..4e8856e 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidParameterException.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/exception/InvalidParameterException.java
@@ -1,75 +1,105 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.exception.InvalidParameterException.java
- * Created on: Nov 19, 2016
- */
-package fr.bigeon.gclc.exception;
-
-/** This exception is thrown during command definitions to indicate a wrong
- * parameter definition.
- *
- * This class is particularly used by
- * {@link fr.bigeon.gclc.command.ParametrizedCommand parameterized commands}.
- *
- * @author Emmanuel Bigeon */
-public class InvalidParameterException extends Exception {
-
- /** the SVUID. */
- private static final long serialVersionUID = 1L;
-
- /** Create the exception with a message.
- *
- * @param message the message */
- public InvalidParameterException(final String message) {
- super(message);
- }
-
- /** Create the exception with a message and a cause.
- *
- * @param message the message
- * @param cause the cause */
- public InvalidParameterException(final String message, final Throwable cause) {
- super(message, cause);
- }
-
- /** Create the exception with a cause.
- *
- * @param cause the cause */
- public InvalidParameterException(final Throwable cause) {
- super(cause);
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.exception.InvalidParameterException.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.exception;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+/** This exception is thrown during command definitions to indicate a wrong
+ * parameter definition.
+ *
+ * @author Emmanuel Bigeon */
+public class InvalidParameterException extends Exception {
+
+ /** the SVUID. */
+ private static final long serialVersionUID = 1L;
+
+ /** Create the exception with a message.
+ *
+ * @param message the message */
+ public InvalidParameterException(final String message) {
+ super(message);
+ }
+
+ /** Create the exception with a message and a cause.
+ *
+ * @param message the message
+ * @param cause the cause */
+ public InvalidParameterException(final String message, final Throwable cause) {
+ super(message, cause);
+ }
+
+ /** Create the exception with a cause.
+ *
+ * @param cause the cause */
+ public InvalidParameterException(final Throwable cause) {
+ super(cause);
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/i18n/Messages.java b/gclc/src/main/java/fr/bigeon/gclc/i18n/Messages.java
index 3d48c3b..8abd02f 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/i18n/Messages.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/i18n/Messages.java
@@ -1,81 +1,114 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.i18n.Messages.java
- * Created on: Jun 1, 2016
- */
-package fr.bigeon.gclc.i18n;
-
-import java.text.MessageFormat;
-import java.util.MissingResourceException;
-import java.util.ResourceBundle;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-/** Internationalization class.
- *
- * @author Emmanuel Bigeon */
-public final class Messages {
- /** The resource bundle name. */
- private static final String BUNDLE_NAME = "fr.bigeon.gclc.l10n.messages"; //$NON-NLS-1$
-
- /** The resource bundle. */
- private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
- .getBundle(BUNDLE_NAME);
-
- /** The class logger. */
- private static final Logger LOGGER = Logger
- .getLogger(Messages.class.getName());
-
- /** Utility class. */
- private Messages() {
- // Utility class
- }
-
- /** Get formatted internationalized messages.
- *
- * @param key the message key
- * @param args the formatting arguments
- * @return the formatted internationalized message */
- public static String getString(final String key, final Object... args) {
- try {
- return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args);
- } catch (final MissingResourceException e) {
- LOGGER.log(Level.WARNING,
- "Unrecognized internationalization message key: " + key, e); //$NON-NLS-1$
- return '!' + key + '!';
- }
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.i18n.Messages.java
+ * Created on: Jun 1, 2016
+ */
+package fr.bigeon.gclc.i18n;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.text.MessageFormat;
+import java.util.MissingResourceException;
+import java.util.ResourceBundle;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/** Internationalization class.
+ *
+ * @author Emmanuel Bigeon */
+public final class Messages {
+ /** The resource bundle name. */
+ private static final String BUNDLE_NAME = "fr.bigeon.gclc.l10n.messages"; //$NON-NLS-1$
+
+ /** The resource bundle. */
+ private static final ResourceBundle RESOURCE_BUNDLE = ResourceBundle
+ .getBundle(BUNDLE_NAME);
+
+ /** The class logger. */
+ private static final Logger LOGGER = Logger
+ .getLogger(Messages.class.getName());
+
+ /** Utility class. */
+ private Messages() {
+ // Utility class
+ }
+
+ /** Get formatted internationalized messages.
+ *
+ * @param key the message key
+ * @param args the formatting arguments
+ * @return the formatted internationalized message */
+ public static String getString(final String key, final Object... args) {
+ try {
+ return MessageFormat.format(RESOURCE_BUNDLE.getString(key), args);
+ } catch (final MissingResourceException e) {
+ LOGGER.log(Level.WARNING,
+ "Unrecognized internationalization message key: " + key, e); //$NON-NLS-1$
+ return '!' + key + '!';
+ }
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleInput.java b/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleInput.java
index f558a3e..b529744 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleInput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleInput.java
@@ -1,118 +1,152 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.manager.ConsoleInput.java
- * Created on: Nov 13, 2017
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.IOException;
-import java.io.InterruptedIOException;
-
-import fr.bigeon.gclc.tools.StringProvider;
-
-/** A console application input.
- *
- * @author Emmanuel Bigeon */
-public interface ConsoleInput extends AutoCloseable {
-
- /** Closes the input.
- *
- * @throws IOException if the close raised an exception */
- @Override
- void close() throws IOException;
-
- /** Get the prompt string.
- *
- * @return the prompt prefix */
- StringProvider getPrompt();
-
- /** Indicate to the input that is should interrompt the prompting, if
- * possible.
- *
- * The pending {@link #prompt()} or {@link #prompt(String)} operations
- * should return immediatly. However the returned value can be anything
- * (from the partial prompt content to an empty string or even a null
- * pointer). */
- void interruptPrompt();
-
- /** Test if the input is closed.
- *
- * If this is true, {@link #prompt()} methods will return immediatly and a
- * null chain.
- *
- * @return if the manager is closed. */
- boolean isClosed();
-
- /** Prompt the user.
- *
- * @return the user inputed string
- * @throws IOException if the manager is closed or could not read the prompt
- * @throws InterruptedIOException if the prompt was interrupted */
- String prompt() throws IOException;
-
- /** Prompt the user, with an allotated time to answer.
- *
- * @param timeout the time to wait in milliseconds
- * @return the user inputed string, null if the timeout was reached
- * @throws IOException if the manager is closed or could not read the prompt
- * @throws InterruptedIOException if the prompt was interrupted */
- String prompt(long timeout) throws IOException;
-
- /** Prompt the user, with a hint on what is prompted.
- *
- * @param message the message to prompt the user
- * @return the user inputed string
- * @throws IOException if the manager is closed or could not read the prompt
- * @throws InterruptedIOException if the prompt was interrupted */
- String prompt(String message) throws IOException;
-
- /** Prompt the user, with a hint on what is prompted and an allotated time
- * to answer.
- *
- * @param timeout the time to wait in milliseconds
- * @param message the message to prompt the user
- * @return the user inputed string, null if the timeout was reached
- * @throws IOException if the manager is closed or could not read the prompt
- * @throws InterruptedIOException if the prompt was interrupted */
- String prompt(String message, long timeout) throws IOException;
-
- /** Set a prompting prefix.
- *
- * @param prompt the prompt */
- void setPrompt(String prompt);
-
- void setPrompt(StringProvider string);
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.ConsoleInput.java
+ * Created on: Nov 13, 2017
+ */
+package fr.bigeon.gclc.manager;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+import java.io.InterruptedIOException;
+
+import fr.bigeon.gclc.tools.StringProvider;
+
+/** A console application input.
+ *
+ * @author Emmanuel Bigeon */
+public interface ConsoleInput extends AutoCloseable {
+
+ /** Closes the input.
+ *
+ * @throws IOException if the close raised an exception */
+ @Override
+ void close() throws IOException;
+
+ /** Get the prompt string.
+ *
+ * @return the prompt prefix */
+ StringProvider getPrompt();
+
+ /** Indicate to the input that is should interrompt the prompting, if possible.
+ *
+ * The pending {@link #prompt()} or {@link #prompt(String)} operations should
+ * return immediatly. However the returned value can be anything (from the
+ * partial prompt content to an empty string or even a null pointer). */
+ void interruptPrompt();
+
+ /** Test if the input is closed.
+ *
+ * If this is true, {@link #prompt()} methods will return immediatly and a null
+ * chain.
+ *
+ * @return if the manager is closed. */
+ boolean isClosed();
+
+ /** Prompt the user.
+ *
+ * @return the user inputed string
+ * @throws IOException if the manager is closed or could not read the prompt
+ * @throws InterruptedIOException if the prompt was interrupted */
+ String prompt() throws IOException;
+
+ /** Prompt the user, with an allotated time to answer.
+ *
+ * @param timeout the time to wait in milliseconds
+ * @return the user inputed string, null if the timeout was reached
+ * @throws IOException if the manager is closed or could not read the prompt
+ * @throws InterruptedIOException if the prompt was interrupted */
+ String prompt(long timeout) throws IOException;
+
+ /** Prompt the user, with a hint on what is prompted.
+ *
+ * @param message the message to prompt the user
+ * @return the user inputed string
+ * @throws IOException if the manager is closed or could not read the prompt
+ * @throws InterruptedIOException if the prompt was interrupted */
+ String prompt(String message) throws IOException;
+
+ /** Prompt the user, with a hint on what is prompted and an allotated time to
+ * answer.
+ *
+ * @param timeout the time to wait in milliseconds
+ * @param message the message to prompt the user
+ * @return the user inputed string, null if the timeout was reached
+ * @throws IOException if the manager is closed or could not read the prompt
+ * @throws InterruptedIOException if the prompt was interrupted */
+ String prompt(String message, long timeout) throws IOException;
+
+ /** Set a prompting prefix.
+ *
+ * @param prompt the prompt */
+ void setPrompt(String prompt);
+
+ /** Set the prompting string.
+ *
+ * @param string the prompt string */
+ void setPrompt(StringProvider string);
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleOutput.java b/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleOutput.java
index 25545ff..60ece86 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleOutput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/manager/ConsoleOutput.java
@@ -1,76 +1,109 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.manager.ConsoleOutput.java
- * Created on: Nov 13, 2017
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.IOException;
-
-/** A console output definition.
- *
- * @author Emmanuel Bigeon */
-public interface ConsoleOutput extends AutoCloseable {
-
- /** Test if the output is closed.
- *
- * @return if the manager is closed. */
- boolean isClosed();
-
- /** Print a string.
- *
- * @param text the message to print (without line break at the end).
- * @throws IOException if the manager is closed or could not read the
- * prompt */
- void print(String text) throws IOException;
-
- /** Prints an end of line.
- *
- * @throws IOException if the manager is closed or could not read the
- * prompt */
- void println() throws IOException;
-
- /** Print a string followed by an end of line.
- *
- * This is the same as calling successively {@link #print(String)} and
- * {@link #println()}.
- *
- * @param message the message to print
- * @throws IOException if the manager is closed or could not read the
- * prompt */
- void println(String message) throws IOException;
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.ConsoleOutput.java
+ * Created on: Nov 13, 2017
+ */
+package fr.bigeon.gclc.manager;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+
+/** A console output definition.
+ *
+ * @author Emmanuel Bigeon */
+public interface ConsoleOutput extends AutoCloseable {
+
+ /** Test if the output is closed.
+ *
+ * @return if the manager is closed. */
+ boolean isClosed();
+
+ /** Print a string.
+ *
+ * @param text the message to print (without line break at the end).
+ * @throws IOException if the manager is closed or could not read the
+ * prompt */
+ void print(String text) throws IOException;
+
+ /** Prints an end of line.
+ *
+ * @throws IOException if the manager is closed or could not read the
+ * prompt */
+ void println() throws IOException;
+
+ /** Print a string followed by an end of line.
+ *
+ * This is the same as calling successively {@link #print(String)} and
+ * {@link #println()}.
+ *
+ * @param message the message to print
+ * @throws IOException if the manager is closed or could not read the
+ * prompt */
+ void println(String message) throws IOException;
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/EmptyInput.java b/gclc/src/main/java/fr/bigeon/gclc/manager/EmptyInput.java
index 27452b0..a2d6e74 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/EmptyInput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/manager/EmptyInput.java
@@ -1,124 +1,157 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.manager.EmptyInput.java
- * Created on: Nov 13, 2017
- */
-package fr.bigeon.gclc.manager;
-
-import fr.bigeon.gclc.tools.ConstantString;
-import fr.bigeon.gclc.tools.StringProvider;
-
-/** A console input that return empty to all prompting.
- *
- * @author Emmanuel Bigeon */
-public final class EmptyInput implements ConsoleInput {
-
- /** The empty prompter. */
- public static final ConsoleInput INSTANCE = new EmptyInput();
- /** The empty input. */
- private EmptyInput() {
- //
- }
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#close() */
- @Override
- public void close() {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
- @Override
- public StringProvider getPrompt() {
- return new ConstantString(""); //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
- @Override
- public void interruptPrompt() {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
- @Override
- public boolean isClosed() {
- return false;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
- @Override
- public String prompt() {
- return ""; //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
- @Override
- public String prompt(final long timeout) {
- return ""; //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
- @Override
- public String prompt(final String message) {
- return ""; //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
- * long) */
- @Override
- public String prompt(final String message,
- final long timeout) {
- return ""; //$NON-NLS-1$
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
- @Override
- public void setPrompt(final String prompt) {
- //
- }
-
- @Override
- public void setPrompt(StringProvider string) {
- //
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.EmptyInput.java
+ * Created on: Nov 13, 2017
+ */
+package fr.bigeon.gclc.manager;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import fr.bigeon.gclc.tools.ConstantString;
+import fr.bigeon.gclc.tools.StringProvider;
+
+/** A console input that return empty to all prompting.
+ *
+ * @author Emmanuel Bigeon */
+public final class EmptyInput implements ConsoleInput {
+
+ /** The empty prompter. */
+ public static final ConsoleInput INSTANCE = new EmptyInput();
+ /** The empty input. */
+ private EmptyInput() {
+ //
+ }
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#close() */
+ @Override
+ public void close() {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
+ @Override
+ public StringProvider getPrompt() {
+ return new ConstantString(""); //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
+ @Override
+ public void interruptPrompt() {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
+ @Override
+ public boolean isClosed() {
+ return false;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
+ @Override
+ public String prompt() {
+ return ""; //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(long) */
+ @Override
+ public String prompt(final long timeout) {
+ return ""; //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
+ @Override
+ public String prompt(final String message) {
+ return ""; //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
+ * long) */
+ @Override
+ public String prompt(final String message,
+ final long timeout) {
+ return ""; //$NON-NLS-1$
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
+ @Override
+ public void setPrompt(final String prompt) {
+ //
+ }
+
+ @Override
+ public void setPrompt(StringProvider string) {
+ //
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/prompt/CLIPrompter.java b/gclc/src/main/java/fr/bigeon/gclc/prompt/CLIPrompter.java
index e65c874..1a104d1 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/prompt/CLIPrompter.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/prompt/CLIPrompter.java
@@ -1,516 +1,549 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/** acide:fr.bigeon.acide.tool.CLIPrompter.java
- * Created on: Jul 31, 2014 */
-package fr.bigeon.gclc.prompt;
-
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** The {@link CLIPrompter} class is a utility class that provides method to
- * prompt the user.
- *
- * @author Emmanuel BIGEON */
-public final class CLIPrompter {
-
- /** The zero integer. */
- private static final Integer ZERO = Integer.valueOf(0);
- /** message key for format error in prompting a choice. */
- private static final String PROMPTCHOICE_FORMATERR = "promptchoice.formaterr"; //$NON-NLS-1$
- /** message key for out of bound error in prompting a choice. */
- private static final String PROMPTCHOICE_OUTOFBOUNDS = "promptchoice.outofbounds"; //$NON-NLS-1$
- /** message key for first form of no in prompting a choice. */
- private static final String PROMPTBOOL_CHOICES_NO1 = "promptbool.choices.no1"; //$NON-NLS-1$
- /** message key for first form of yes in prompting a choice. */
- private static final String PROMPTBOOL_CHOICES_YES1 = "promptbool.choices.yes1"; //$NON-NLS-1$
- /** Message key for boolean choosing. */
- private static final String BOOL_CHOICES = "promptbool.choices"; //$NON-NLS-1$
- /** Message key for the list end of prompt symbol. */
- private static final String LIST_DISP_KEY = "promptlist.exit.dispkey"; //$NON-NLS-1$
- /** Message key for the line prompt. */
- private static final String PROMPT = "prompt.lineprompt"; //$NON-NLS-1$
- /** Message key for the separation of choices selection. */
- private static final String LIST_CHOICE_SEP = "promptlist.multi.sepkey"; //$NON-NLS-1$
- /** The class logger. */
- private static final Logger LOGGER = Logger
- .getLogger(CLIPrompter.class.getName());
-
- /** Utility class. */
- private CLIPrompter() {
- // Utility class
- }
-
- /** Add a user choice to the list.
- *
- * @param val the string to parse
- * @param chs the list of integers
- * @param index the max index of choice
- * @return if the parsing was done correctly */
- private static boolean addUserChoice(final String val,
- final List
- * This package is used for the formatting of prompts for the user. The
- * {@link fr.bigeon.gclc.prompt.CLIPrompter} class provides utility methods to
- * retrieve certain basic type of data from the user or to give list choices.
- *
- * The {@link fr.bigeon.gclc.prompt.CLIPrompterMessages} class is used for
- * internationalization of the prompting methods.
- *
- * @author Emmanuel BIGEON */
-package fr.bigeon.gclc.prompt;
\ No newline at end of file
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/** gclc:fr.bigeon.gclc.prompt.package-info.java
+ * Created on: Sep 6, 2014 */
+/** Client prompting related objects.
+ *
+ * This package is used for the formatting of prompts for the user. The
+ * {@link fr.bigeon.gclc.prompt.CLIPrompter} class provides utility methods to
+ * retrieve certain basic type of data from the user or to give list choices.
+ *
+ * The {@link fr.bigeon.gclc.prompt.CLIPrompterMessages} class is used for
+ * internationalization of the prompting methods.
+ *
+ * @author Emmanuel BIGEON */
+package fr.bigeon.gclc.prompt;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
diff --git a/gclc/src/main/java/fr/bigeon/gclc/tools/ConstantString.java b/gclc/src/main/java/fr/bigeon/gclc/tools/ConstantString.java
index 2b3afab..451bc85 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/tools/ConstantString.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/tools/ConstantString.java
@@ -34,17 +34,57 @@
*/
package fr.bigeon.gclc.tools;
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+
+/** A {@link StringProvider} that hold a constant string.
+ *
+ * @author Emmanuel Bigeon */
public class ConstantString implements StringProvider {
- private String string;
-
-
-
- @Override
- public String apply() {
- return string;
}
+ private final String string;
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.tools.StringProvider#apply() */
+ @Override
+ public String apply() {
+ return string;
+ }
- public ConstantString(String string) {
- this.string = string;
- }
+ /** Create a provider for a string.
+ *
+ * @param string the string */
+ public ConstantString(String string) {
+ this.string = string;
+ }
}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/tools/PrintUtils.java b/gclc/src/main/java/fr/bigeon/gclc/tools/PrintUtils.java
index ecbe206..f2aa18c 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/tools/PrintUtils.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/tools/PrintUtils.java
@@ -1,116 +1,149 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * acide:fr.bigeon.acide.tools.PrintUtils.java
- * Created on: Jan 20, 2015
- */
-package fr.bigeon.gclc.tools;
-
-import java.util.ArrayList;
-import java.util.List;
-
-/** A tool class for printing text in a console.
- *
- * @author Emmanuel BIGEON */
-public final class PrintUtils {
-
- /** The continuation dot string. */
- private static final String CONT_DOT = "..."; //$NON-NLS-1$
- /** The continuation dot string length. */
- private static final int CONT_DOT_LENGTH = CONT_DOT.length();
- /** The empty string constant. */
- private static final String EMPTY = ""; //$NON-NLS-1$
-
- /** Utility class. */
- private PrintUtils() {
- // Utility class
- }
-
- /** Print the text possibly cutting it if it goes over the authorized length
- * and adding a mark of continuation.
- *
- * @param text the text to print
- * @param nbCharacters the number of characters of the resulting text
- * @param indicateTooLong if an indication shell be given that the text
- * didn't fit
- * @return the text to print (will be of exactly nbCharacters). */
- public static String print(final String text, final int nbCharacters,
- final boolean indicateTooLong) {
- StringBuilder res = new StringBuilder(text);
- if (res.length() > nbCharacters) {
- // Cut
- if (indicateTooLong) {
- // With suspension dots
- res = res.replace(nbCharacters - CONT_DOT_LENGTH, text.length(),
- CONT_DOT);
- } else {
- res = res.replace(nbCharacters, text.length(), ""); //$NON-NLS-1$
- }
- }
- while (res.length() < nbCharacters) {
- // Add trailing space
- res.append(' ');
- }
- return res.toString();
- }
-
- /** Wrap the text, cutting at spaces.
- *
- * @param description the element to wrap in lines
- * @param i the length of the wrap
- * @return the list of resulting strings */
- public static List
* Implementations of this interface will provide a string, this internal state
* of the object may be so that successive calls to the apply method return
* different results.
*
- * @author Emmanuel
- *
- */
+ * @author Emmanuel */
public interface StringProvider {
- String apply();
+ /** Provide a string.
+ *
+ * @return the string */
+ String apply();
}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/tools/AOutputForwardRunnable.java b/gclc/src/main/java/fr/bigeon/gclc/utils/AOutputForwardRunnable.java
similarity index 73%
rename from gclc/src/main/java/fr/bigeon/gclc/tools/AOutputForwardRunnable.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/AOutputForwardRunnable.java
index c282a48..63be57c 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/tools/AOutputForwardRunnable.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/AOutputForwardRunnable.java
@@ -1,137 +1,168 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.tools.AOutputForwardRunnable.java
- * Created on: Dec 1, 2016
- */
-package fr.bigeon.gclc.tools;
-
-import java.io.IOException;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/** An incomplete implematation used to forward messages from a piped console.
- *
- * This forwarding can be interrupted without closing the piped manager.
- *
- * @author Emmanuel Bigeon */
-public abstract class AOutputForwardRunnable implements Runnable {
-
- /** The class logger. */
- private static final Logger LOGGER = Logger
- .getLogger(AOutputForwardRunnable.class.getName());
- /** The default timeout (one tenth of second). */
- private static final long DEFAULT_TIMEOUT = 100;
- /** The manager. */
- private final PipedConsoleOutput manager;
- /** The timeout. */
- private final long timeout;
-
- /** Create a forwarding runnable.
- *
- * @param manager the manager */
- public AOutputForwardRunnable(final PipedConsoleOutput manager) {
- super();
- this.manager = manager;
- timeout = DEFAULT_TIMEOUT;
- }
-
- /** Create a forward runnable with the given timeout.
- *
- * Short timeout will be very responsive to the application actual messages,
- * but may use computation time if the application is not verbose. Long
- * timeout will save computation time, but will read batches of messages at
- * once if the application is verbose. The right length for the timeout is
- * likely to depend on the application and the use of it.
- *
- * If you do not know what timeout length to use, please use the
- * {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor.
- *
- * @param manager the manager
- * @param timeout the timeout between message requests. */
- public AOutputForwardRunnable(final PipedConsoleOutput manager,
- final long timeout) {
- super();
- this.manager = manager;
- this.timeout = timeout;
- }
-
- /** Do forward the line.
- *
- * @param m the line to forward */
- protected abstract void forwardLine(String m);
-
- /** Test if the runable is still running.
- *
- * @return if the thread should keep running */
- protected abstract boolean isRunning();
-
- /* (non-Javadoc)
- * @see java.lang.Runnable#run() */
- @Override
- public final void run() {
- try {
- while (isRunning()) {
- while (isRunning() && !manager.available()) {
- waitASec();
- }
- if (!isRunning()) {
- return;
- }
- final String m = manager.readNextLine();
- forwardLine(m);
- }
- } catch (final IOException e) {
- LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
- e);
- }
- }
-
- /** a method to wait some time. */
- protected final void waitASec() {
- try {
- synchronized (this) {
- wait(timeout);
- }
- } catch (final InterruptedException e) {
- LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
- e);
- Thread.currentThread().interrupt();
- }
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.tools.AOutputForwardRunnable.java
+ * Created on: Dec 1, 2016
+ */
+package fr.bigeon.gclc.utils;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/** An incomplete implematation used to forward messages from a piped console.
+ *
+ * This forwarding can be interrupted without closing the piped manager.
+ *
+ * @author Emmanuel Bigeon */
+public abstract class AOutputForwardRunnable implements Runnable {
+
+ /** The class logger. */
+ private static final Logger LOGGER = Logger
+ .getLogger(AOutputForwardRunnable.class.getName());
+ /** The default timeout (one tenth of second). */
+ private static final long DEFAULT_TIMEOUT = 100;
+ /** The manager. */
+ private final PipedConsoleOutput manager;
+ /** The timeout. */
+ private final long timeout;
+
+ /** Create a forwarding runnable.
+ *
+ * @param manager the manager */
+ public AOutputForwardRunnable(final PipedConsoleOutput manager) {
+ super();
+ this.manager = manager;
+ timeout = DEFAULT_TIMEOUT;
+ }
+
+ /** Create a forward runnable with the given timeout.
+ *
+ * Short timeout will be very responsive to the application actual messages,
+ * but may use computation time if the application is not verbose. Long
+ * timeout will save computation time, but will read batches of messages at
+ * once if the application is verbose. The right length for the timeout is
+ * likely to depend on the application and the use of it.
+ *
+ * If you do not know what timeout length to use, please use the
+ * {@link #AOutputForwardRunnable(PipedConsoleOutput)} constructor.
+ *
+ * @param manager the manager
+ * @param timeout the timeout between message requests. */
+ public AOutputForwardRunnable(final PipedConsoleOutput manager,
+ final long timeout) {
+ super();
+ this.manager = manager;
+ this.timeout = timeout;
+ }
+
+ /** Do forward the line.
+ *
+ * @param m the line to forward */
+ protected abstract void forwardLine(String m);
+
+ /** Test if the runable is still running.
+ *
+ * @return if the thread should keep running */
+ protected abstract boolean isRunning();
+
+ /* (non-Javadoc)
+ * @see java.lang.Runnable#run() */
+ @Override
+ public final void run() {
+ try {
+ while (isRunning()) {
+ while (isRunning() && !manager.available()) {
+ waitASec();
+ }
+ if (!isRunning()) {
+ return;
+ }
+ final String m = manager.readNextLine();
+ forwardLine(m);
+ }
+ } catch (final IOException e) {
+ LOGGER.log(Level.SEVERE, "Unexpected problem in manager", //$NON-NLS-1$
+ e);
+ }
+ }
+
+ /** a method to wait some time. */
+ protected final void waitASec() {
+ try {
+ synchronized (this) {
+ wait(timeout);
+ }
+ } catch (final InterruptedException e) {
+ LOGGER.log(Level.SEVERE, "Interrupted wait", //$NON-NLS-1$
+ e);
+ Thread.currentThread().interrupt();
+ }
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleInput.java b/gclc/src/main/java/fr/bigeon/gclc/utils/PipedConsoleInput.java
similarity index 75%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleInput.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/PipedConsoleInput.java
index ad13c34..ba85fd7 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleInput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/PipedConsoleInput.java
@@ -1,160 +1,194 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java
- * Created on: Nov 18, 2016
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.IOException;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
-
-import fr.bigeon.gclc.tools.StringProvider;
-
-/** This console input allows to enter commands and retrieve the output as an
- * input.
- *
- * This console input is used to internally pilot an application. This can be
- * used to test application behavior.
- *
- * @author Emmanuel Bigeon */
-public final class PipedConsoleInput
- implements ConsoleInput {
-
- /** THe inner manager. */
- private final StreamConsoleInput innerManager;
- /** The stream to pipe commands into. */
- private final PipedOutputStream commandInput;
- /** The stream for the application to read commands from. */
- private final PipedInputStream in;
- /** The writing thread. */
- private final WritingRunnable writing;
-
- /** Create a manager that will write and read through piped stream.
- *
- * @param outPrint the stream to write the prompting messages to
- * @throws IOException if the piping failed for streams */
- public PipedConsoleInput(final PrintStream outPrint) throws IOException {
- commandInput = new PipedOutputStream();
- in = new PipedInputStream(commandInput);
- innerManager = new StreamConsoleInput(outPrint, in,
- StandardCharsets.UTF_8);
- writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
- final Thread th = new Thread(writing,
- "GCLC console piped input stream"); //$NON-NLS-1$
- th.start();
- }
-
- @Override
- public void close() throws IOException {
- writing.setRunning(false);
- in.close();
- innerManager.close();
- commandInput.close();
- }
-
- @Override
- public StringProvider getPrompt() {
- return innerManager.getPrompt();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
- @Override
- public void interruptPrompt() {
- innerManager.interruptPrompt();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
- @Override
- public boolean isClosed() {
- return innerManager.isClosed();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
- @Override
- public String prompt() throws IOException {
- return innerManager
- .prompt(innerManager.getPrompt() + System.lineSeparator());
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
- @Override
- public String prompt(final long timeout) throws IOException {
- return innerManager.prompt(timeout);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
- @Override
- public String prompt(final String message) throws IOException {
- return innerManager.prompt(message + System.lineSeparator());
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
- * long) */
- @Override
- public String prompt(final String message, final long timeout) throws IOException {
- return innerManager.prompt(message + System.lineSeparator(), timeout);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
- @Override
- public void setPrompt(final String prompt) {
- innerManager.setPrompt(prompt);
- }
-
- @Override
- public void setPrompt(StringProvider string) {
- innerManager.setPrompt(string);
- }
-
- /** Type a message in the input.
- *
- * @param content the content to type to the application
- * @throws IOException if the typing failed */
- public void type(final String content) throws IOException {
- writing.addMessage(content);
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java
+ * Created on: Nov 18, 2016
+ */
+package fr.bigeon.gclc.utils;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.tools.StringProvider;
+
+/** This console input allows to enter commands and retrieve the output as an
+ * input.
+ *
+ * This console input is used to internally pilot an application. This can be
+ * used to test application behavior.
+ *
+ * @author Emmanuel Bigeon */
+public final class PipedConsoleInput
+ implements ConsoleInput {
+
+ /** THe inner manager. */
+ private final StreamConsoleInput innerManager;
+ /** The stream to pipe commands into. */
+ private final PipedOutputStream commandInput;
+ /** The stream for the application to read commands from. */
+ private final PipedInputStream in;
+ /** The writing thread. */
+ private final WritingRunnable writing;
+
+ /** Create a manager that will write and read through piped stream.
+ *
+ * @param outPrint the stream to write the prompting messages to
+ * @throws IOException if the piping failed for streams */
+ public PipedConsoleInput(final PrintStream outPrint) throws IOException {
+ commandInput = new PipedOutputStream();
+ in = new PipedInputStream(commandInput);
+ innerManager = new StreamConsoleInput(outPrint, in,
+ StandardCharsets.UTF_8);
+ writing = new WritingRunnable(commandInput, StandardCharsets.UTF_8);
+ final Thread th = new Thread(writing,
+ "GCLC console piped input stream"); //$NON-NLS-1$
+ th.start();
+ }
+
+ @Override
+ public void close() throws IOException {
+ writing.setRunning(false);
+ in.close();
+ innerManager.close();
+ commandInput.close();
+ }
+
+ @Override
+ public StringProvider getPrompt() {
+ return innerManager.getPrompt();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#interruptPrompt() */
+ @Override
+ public void interruptPrompt() {
+ innerManager.interruptPrompt();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#isClosed() */
+ @Override
+ public boolean isClosed() {
+ return innerManager.isClosed();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt() */
+ @Override
+ public String prompt() throws IOException {
+ return innerManager
+ .prompt(innerManager.getPrompt() + System.lineSeparator());
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
+ @Override
+ public String prompt(final long timeout) throws IOException {
+ return innerManager.prompt(timeout);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String) */
+ @Override
+ public String prompt(final String message) throws IOException {
+ return innerManager.prompt(message + System.lineSeparator());
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#prompt(java.lang.String,
+ * long) */
+ @Override
+ public String prompt(final String message, final long timeout) throws IOException {
+ return innerManager.prompt(message + System.lineSeparator(), timeout);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
+ @Override
+ public void setPrompt(final String prompt) {
+ innerManager.setPrompt(prompt);
+ }
+
+ @Override
+ public void setPrompt(StringProvider string) {
+ innerManager.setPrompt(string);
+ }
+
+ /** Type a message in the input.
+ *
+ * @param content the content to type to the application
+ * @throws IOException if the typing failed */
+ public void type(final String content) throws IOException {
+ writing.addMessage(content);
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleOutput.java b/gclc/src/main/java/fr/bigeon/gclc/utils/PipedConsoleOutput.java
similarity index 74%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleOutput.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/PipedConsoleOutput.java
index eb89110..8dc2a5b 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/PipedConsoleOutput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/PipedConsoleOutput.java
@@ -1,153 +1,188 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java
- * Created on: Nov 18, 2016
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
-
-/** This console output allows to retrieve the output as an input.
- *
- * This console output is used to internally pilot an application. This can be
- * used to test application behavior.
- *
- * @author Emmanuel Bigeon */
-public final class PipedConsoleOutput
- implements ConsoleOutput {
-
- /** The encoding between streams. */
- private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
- /** THe inner manager. */
- private final StreamConsoleOutput innerManager;
- /** The reader to get application return from. */
- private final BufferedReader commandBuffOutput;
- /** The stream to get application return from. */
- private final PipedInputStream commandOutput;
- /** The print writer for application to write return to. */
- private final PrintStream outPrint;
- /** The reading thread. */
- private final ReadingRunnable reading;
-
- /** Create a manager that will write and read through piped stream.
- *
- * @throws IOException if the piping failed for streams */
- public PipedConsoleOutput() throws IOException {
- commandOutput = new PipedInputStream();
- final PipedOutputStream out = new PipedOutputStream(commandOutput);
- commandBuffOutput = new BufferedReader(
- new InputStreamReader(commandOutput, StandardCharsets.UTF_8));
- outPrint = new PrintStream(out, true, UTF_8);
- innerManager = new StreamConsoleOutput(outPrint);
- reading = new ReadingRunnable(commandBuffOutput);
- final Thread th = new Thread(reading, "GCLC console output forward"); //$NON-NLS-1$
- th.setDaemon(true);
- th.start();
- }
-
- /** Test if there is available data.
- *
- * @return the content of the next line written by the application
- * @throws IOException if the reading failed */
- public boolean available() throws IOException {
- return reading.hasMessage();
- }
-
- /* (non-Javadoc)
- * @see java.lang.AutoCloseable#close() */
- @Override
- public void close() throws IOException {
- reading.setRunning(false);
- innerManager.close();
- outPrint.close();
- commandBuffOutput.close();
- commandOutput.close();
- }
-
- /** Wait for a specific message to arrive.
- *
- * When this method returns, the message was appended to the data, it
- * may or may not be the next line of data.
- *
- * @param message the message
- * @return the thread to join to wait for message delivery
- * @see fr.bigeon.gclc.manager.ReadingRunnable#getWaitForDelivery(java.lang.String) */
- public Thread getWaitForDelivery(final String message) {
- return reading.getWaitForDelivery(message);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
- @Override
- public boolean isClosed() {
- return innerManager.isClosed();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
- @Override
- public void print(final String object) throws IOException {
- innerManager.print(object);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
- @Override
- public void println() throws IOException {
- innerManager.println();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
- @Override
- public void println(final String object) throws IOException {
- innerManager.println(object);
- }
-
- /** Read the next line of data.
- *
- * @return the content of the next line written by the application
- * @throws IOException if the reading failed */
- public String readNextLine() throws IOException {
- return reading.getMessage();
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc-test:fr.bigeon.gclc.test.TestConsoleManager.java
+ * Created on: Nov 18, 2016
+ */
+package fr.bigeon.gclc.utils;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** This console output allows to retrieve the output as an input.
+ *
+ * This console output is used to internally pilot an application. This can be
+ * used to test application behavior.
+ *
+ * @author Emmanuel Bigeon */
+public final class PipedConsoleOutput
+ implements ConsoleOutput {
+
+ /** The encoding between streams. */
+ private static final String UTF_8 = "UTF-8"; //$NON-NLS-1$
+ /** THe inner manager. */
+ private final StreamConsoleOutput innerManager;
+ /** The reader to get application return from. */
+ private final BufferedReader commandBuffOutput;
+ /** The stream to get application return from. */
+ private final PipedInputStream commandOutput;
+ /** The print writer for application to write return to. */
+ private final PrintStream outPrint;
+ /** The reading thread. */
+ private final ReadingRunnable reading;
+
+ /** Create a manager that will write and read through piped stream.
+ *
+ * @throws IOException if the piping failed for streams */
+ public PipedConsoleOutput() throws IOException {
+ commandOutput = new PipedInputStream();
+ final PipedOutputStream out = new PipedOutputStream(commandOutput);
+ commandBuffOutput = new BufferedReader(
+ new InputStreamReader(commandOutput, StandardCharsets.UTF_8));
+ outPrint = new PrintStream(out, true, UTF_8);
+ innerManager = new StreamConsoleOutput(outPrint);
+ reading = new ReadingRunnable(commandBuffOutput);
+ final Thread th = new Thread(reading, "GCLC console output forward"); //$NON-NLS-1$
+ th.setDaemon(true);
+ th.start();
+ }
+
+ /** Test if there is available data.
+ *
+ * @return the content of the next line written by the application
+ * @throws IOException if the reading failed */
+ public boolean available() throws IOException {
+ return reading.hasMessage();
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.AutoCloseable#close() */
+ @Override
+ public void close() throws IOException {
+ reading.setRunning(false);
+ innerManager.close();
+ outPrint.close();
+ commandBuffOutput.close();
+ commandOutput.close();
+ }
+
+ /** Wait for a specific message to arrive.
+ *
+ * When this method returns, the message was appended to the data, it
+ * may or may not be the next line of data.
+ *
+ * @param message the message
+ * @return the thread to join to wait for message delivery
+ * @see fr.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String) */
+ public Thread getWaitForDelivery(final String message) {
+ return reading.getWaitForDelivery(message);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
+ @Override
+ public boolean isClosed() {
+ return innerManager.isClosed();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
+ @Override
+ public void print(final String object) throws IOException {
+ innerManager.print(object);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
+ @Override
+ public void println() throws IOException {
+ innerManager.println();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String) */
+ @Override
+ public void println(final String object) throws IOException {
+ innerManager.println(object);
+ }
+
+ /** Read the next line of data.
+ *
+ * @return the content of the next line written by the application
+ * @throws IOException if the reading failed */
+ public String readNextLine() throws IOException {
+ return reading.getMessage();
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/ReadingRunnable.java b/gclc/src/main/java/fr/bigeon/gclc/utils/ReadingRunnable.java
similarity index 85%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/ReadingRunnable.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/ReadingRunnable.java
index 7fbfba9..024325d 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/ReadingRunnable.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/ReadingRunnable.java
@@ -1,354 +1,386 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java
- * Created on: Nov 29, 2016
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InterruptedIOException;
-import java.util.ArrayDeque;
-import java.util.Deque;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-/** A runnable to read the piped output.
- *
- * @author Emmanuel Bigeon */
-public final class ReadingRunnable implements Runnable {
-
- /** The runnable to wait for arrival of a message in the queue.
- *
- * @author Emmanuel Bigeon */
- private final class ToWaitRunnable implements Runnable {
- /** The Object. */
- private final Object obj;
- /** The locking object. */
- private final Object start;
- /** The message. */
- private final String message;
- /** The started status. */
- private boolean started = false;
-
- /** Create the waiting runnable.
- *
- * @param obj the object to lock on
- * @param start the object to notify when ready to wait
- * @param message the message to wait for */
- public ToWaitRunnable(final Object obj, final Object start,
- final String message) {
- this.obj = obj;
- this.start = start;
- this.message = message;
- }
-
- /** Test if the waiting runnable is started.
- *
- * @return the started */
- public boolean isStarted() {
- synchronized (start) {
- return started;
- }
- }
-
- /* (non-Javadoc)
- * @see java.lang.Runnable#run() */
- @SuppressWarnings("synthetic-access")
- @Override
- public void run() {
- synchronized (obj) {
- synchronized (start) {
- started = true;
- start.notifyAll();
- }
- while (isRunning()) {
- try {
- obj.wait();
- if (delivering.equals(message)) {
- return;
- }
- } catch (final InterruptedException e) {
- LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
- e);
- Thread.currentThread().interrupt();
- }
- }
- }
- }
- }
-
- /** The thread intteruption logging message. */
- private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
- /** The closed pipe message. */
- private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
- /** Wait timeout. */
- private static final long TIMEOUT = 1000;
- /** Class logger. */
- private static final Logger LOGGER = Logger
- .getLogger(ReadingRunnable.class.getName());
- /** Read messages. */
- private final Deque This method should only be called inside a loop.
- * @param timeout the timeout of the wait.
- * @throws IOException if the runnable was stopped and no essage was found.
- */
- private void doWaitMessage(final long timeout) throws IOException {
- try {
- lock.wait(timeout);
- } catch (final InterruptedException e) {
- LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
- Thread.currentThread().interrupt();
- }
- if (messages.isEmpty() && !running) {
- throw new IOException(CLOSED_PIPE);
- }
- }
-
- /** Get the next message.
- *
- * @return the next read message
- * @throws IOException if the pipe is closed */
- public String getMessage() throws IOException {
- synchronized (lock) {
- if (!running) {
- throw new IOException(CLOSED_PIPE);
- }
- waiting = true;
- waitMessage(TIMEOUT);
- LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$
- waiting = false;
- notifyMessage(messages.peek());
- return messages.poll();
- }
- }
-
- /** Get the next message, but wait only a given time for it.
- *
- * @param timeout the read time out
- * @return The next message that was in the input
- * @throws IOException if the input was closed */
- public String getNextMessage(final long timeout) throws IOException {
- synchronized (lock) {
- if (!running) {
- throw new IOException(CLOSED_PIPE);
- }
- waiting = true;
- doWaitMessage(timeout);
- waiting = false;
- if (messages.isEmpty()) {
- return null;
- }
- return messages.poll();
- }
- }
-
- /** Get a waiting thread for a specific message delivery.
- *
- * @param message the message
- * @return the thread to join to wait for message delivery */
- public Thread getWaitForDelivery(final String message) {
- synchronized (messageBlockerLock) {
- if (!messageBlocker.containsKey(message)) {
- messageBlocker.put(message, new Object());
- }
- final Object obj = messageBlocker.get(message);
- final Object start = new Object();
- final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start,
- message);
- final Thread th = new Thread(waitRunn);
-
- synchronized (start) {
- th.start();
- while (!waitRunn.isStarted()) {
- try {
- start.wait(TIMEOUT);
- } catch (final InterruptedException e) {
- LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
- e);
- Thread.currentThread().interrupt();
- }
- }
- }
- return th;
- }
- }
-
- /** Test if some data is available.
- *
- * @return if a message is waiting
- * @throws IOException if the pipe is closed */
- public boolean hasMessage() throws IOException {
- synchronized (lock) {
- if (!running) {
- throw new IOException(CLOSED_PIPE);
- }
- return !messages.isEmpty();
- }
- }
-
- /** Interrupts the wait on the next message by providing an empty
- * message. */
- public void interrupt() {
- synchronized (lock) {
- if (waiting) {
- messages.offer(""); //$NON-NLS-1$
- lock.notifyAll();
- }
- }
- }
-
- /** Test if this element is still running.
- *
- * @return the running */
- public boolean isRunning() {
- synchronized (lock) {
- return running;
- }
- }
-
- /** Notify the arrival of a given message.
- *
- * @param message the message */
- private void notifyMessage(final String message) {
- synchronized (messageBlockerLock) {
- delivering = message;
- if (messageBlocker.containsKey(message)) {
- final Object mLock = messageBlocker.get(message);
- synchronized (mLock) {
- mLock.notifyAll();
- }
- messageBlocker.remove(message);
- }
- }
- }
-
- /* (non-Javadoc)
- * @see java.lang.Runnable#run() */
- @Override
- public void run() {
- while (running) {
- try {
- String line = reader.readLine();
- if (line == null) {
- // Buffer end
- running = false;
- return;
- }
- LOGGER.finer("Read: " + line); //$NON-NLS-1$
- line = stripNull(line);
- synchronized (lock) {
- messages.add(line);
- lock.notifyAll();
- }
- } catch (final InterruptedIOException e) {
- if (running) {
- LOGGER.info("Reading interrupted"); //$NON-NLS-1$
- }
- LOGGER.log(Level.FINER,
- "Read interruption was caused by an exception", e); //$NON-NLS-1$
- } catch (final IOException e) {
- LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$
- e);
- if (running) {
- LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
- running = false;
- }
- return;
- }
- }
- }
-
- /** Set the running status for this reading runnable.
- *
- * @param running the running to set */
- public void setRunning(final boolean running) {
- synchronized (lock) {
- this.running = running;
- }
- }
-
- /** Wait for the next message to be integratted.
- *
- * @param timeout the timeout to wait
- * @throws IOException if the next message was not delivered and the
- * runnable stopped. */
- private void waitMessage(final long timeout) throws IOException {
- while (messages.isEmpty()) {
- doWaitMessage(timeout);
- }
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java
+ * Created on: Nov 29, 2016
+ */
+package fr.bigeon.gclc.utils;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InterruptedIOException;
+import java.util.ArrayDeque;
+import java.util.Deque;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/** A runnable to read the piped output.
+ *
+ * @author Emmanuel Bigeon */
+public final class ReadingRunnable implements Runnable {
+
+ /** The runnable to wait for arrival of a message in the queue.
+ *
+ * @author Emmanuel Bigeon */
+ private final class ToWaitRunnable implements Runnable {
+ /** The Object. */
+ private final Object obj;
+ /** The locking object. */
+ private final Object start;
+ /** The message. */
+ private final String message;
+ /** The started status. */
+ private boolean started = false;
+
+ /** Create the waiting runnable.
+ *
+ * @param obj the object to lock on
+ * @param start the object to notify when ready to wait
+ * @param message the message to wait for */
+ public ToWaitRunnable(final Object obj, final Object start,
+ final String message) {
+ this.obj = obj;
+ this.start = start;
+ this.message = message;
+ }
+
+ /** Test if the waiting runnable is started.
+ *
+ * @return the started */
+ public boolean isStarted() {
+ synchronized (start) {
+ return started;
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Runnable#run() */
+ @Override
+ public void run() {
+ synchronized (obj) {
+ synchronized (start) {
+ started = true;
+ start.notifyAll();
+ }
+ while (isRunning()) {
+ try {
+ obj.wait();
+ if (delivering.equals(message)) {
+ return;
+ }
+ } catch (final InterruptedException e) {
+ LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
+ e);
+ Thread.currentThread().interrupt();
+ }
+ }
+ }
+ }
+ }
+
+ /** The thread intteruption logging message. */
+ private static final String THREAD_INTERRUPTION_EXCEPTION = "Thread interruption exception."; //$NON-NLS-1$
+ /** The closed pipe message. */
+ private static final String CLOSED_PIPE = "Closed pipe"; //$NON-NLS-1$
+ /** Wait timeout. */
+ private static final long TIMEOUT = 1000;
+ /** Class logger. */
+ private static final Logger LOGGER = Logger
+ .getLogger(ReadingRunnable.class.getName());
+ /** Read messages. */
+ private final Deque This method should only be called inside a loop.
+ * @param timeout the timeout of the wait.
+ * @throws IOException if the runnable was stopped and no essage was found.
+ */
+ private void doWaitMessage(final long timeout) throws IOException {
+ try {
+ lock.wait(timeout);
+ } catch (final InterruptedException e) {
+ LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION, e);
+ Thread.currentThread().interrupt();
+ }
+ if (messages.isEmpty() && !running) {
+ throw new IOException(CLOSED_PIPE);
+ }
+ }
+
+ /** Get the next message.
+ *
+ * @return the next read message
+ * @throws IOException if the pipe is closed */
+ public String getMessage() throws IOException {
+ synchronized (lock) {
+ if (!running) {
+ throw new IOException(CLOSED_PIPE);
+ }
+ waiting = true;
+ waitMessage(TIMEOUT);
+ LOGGER.finest("Polled: " + messages.peek()); //$NON-NLS-1$
+ waiting = false;
+ notifyMessage(messages.peek());
+ return messages.poll();
+ }
+ }
+
+ /** Get the next message, but wait only a given time for it.
+ *
+ * @param timeout the read time out
+ * @return The next message that was in the input
+ * @throws IOException if the input was closed */
+ public String getNextMessage(final long timeout) throws IOException {
+ synchronized (lock) {
+ if (!running) {
+ throw new IOException(CLOSED_PIPE);
+ }
+ waiting = true;
+ doWaitMessage(timeout);
+ waiting = false;
+ if (messages.isEmpty()) {
+ return null;
+ }
+ return messages.poll();
+ }
+ }
+
+ /** Get a waiting thread for a specific message delivery.
+ *
+ * @param message the message
+ * @return the thread to join to wait for message delivery */
+ public Thread getWaitForDelivery(final String message) {
+ synchronized (messageBlockerLock) {
+ if (!messageBlocker.containsKey(message)) {
+ messageBlocker.put(message, new Object());
+ }
+ final Object obj = messageBlocker.get(message);
+ final Object start = new Object();
+ final ToWaitRunnable waitRunn = new ToWaitRunnable(obj, start,
+ message);
+ final Thread th = new Thread(waitRunn);
+
+ synchronized (start) {
+ th.start();
+ while (!waitRunn.isStarted()) {
+ try {
+ start.wait(TIMEOUT);
+ } catch (final InterruptedException e) {
+ LOGGER.log(Level.SEVERE, THREAD_INTERRUPTION_EXCEPTION,
+ e);
+ Thread.currentThread().interrupt();
+ }
+ }
+ }
+ return th;
+ }
+ }
+
+ /** Test if some data is available.
+ *
+ * @return if a message is waiting
+ * @throws IOException if the pipe is closed */
+ public boolean hasMessage() throws IOException {
+ synchronized (lock) {
+ if (!running) {
+ throw new IOException(CLOSED_PIPE);
+ }
+ return !messages.isEmpty();
+ }
+ }
+
+ /** Interrupts the wait on the next message by providing an empty
+ * message. */
+ public void interrupt() {
+ synchronized (lock) {
+ if (waiting) {
+ messages.offer(""); //$NON-NLS-1$
+ lock.notifyAll();
+ }
+ }
+ }
+
+ /** Test if this element is still running.
+ *
+ * @return the running */
+ public boolean isRunning() {
+ synchronized (lock) {
+ return running;
+ }
+ }
+
+ /** Notify the arrival of a given message.
+ *
+ * @param message the message */
+ private void notifyMessage(final String message) {
+ synchronized (messageBlockerLock) {
+ delivering = message;
+ if (messageBlocker.containsKey(message)) {
+ final Object mLock = messageBlocker.get(message);
+ synchronized (mLock) {
+ mLock.notifyAll();
+ }
+ messageBlocker.remove(message);
+ }
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see java.lang.Runnable#run() */
+ @Override
+ public void run() {
+ while (running) {
+ try {
+ String line = reader.readLine();
+ if (line == null) {
+ // Buffer end
+ running = false;
+ return;
+ }
+ LOGGER.finer("Read: " + line); //$NON-NLS-1$
+ line = stripNull(line);
+ synchronized (lock) {
+ messages.add(line);
+ lock.notifyAll();
+ }
+ } catch (final InterruptedIOException e) {
+ if (running) {
+ LOGGER.info("Reading interrupted"); //$NON-NLS-1$
+ }
+ LOGGER.log(Level.FINER,
+ "Read interruption was caused by an exception", e); //$NON-NLS-1$
+ } catch (final IOException e) {
+ LOGGER.log(Level.FINE, "The stream reading threw an exception", //$NON-NLS-1$
+ e);
+ if (running) {
+ LOGGER.severe("Unable to read from stream"); //$NON-NLS-1$
+ running = false;
+ }
+ return;
+ }
+ }
+ }
+
+ /** Set the running status for this reading runnable.
+ *
+ * @param running the running to set */
+ public void setRunning(final boolean running) {
+ synchronized (lock) {
+ this.running = running;
+ }
+ }
+
+ /** Wait for the next message to be integratted.
+ *
+ * @param timeout the timeout to wait
+ * @throws IOException if the next message was not delivered and the
+ * runnable stopped. */
+ private void waitMessage(final long timeout) throws IOException {
+ while (messages.isEmpty()) {
+ doWaitMessage(timeout);
+ }
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/SinkOutput.java b/gclc/src/main/java/fr/bigeon/gclc/utils/SinkOutput.java
similarity index 61%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/SinkOutput.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/SinkOutput.java
index d03f643..125aced 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/SinkOutput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/SinkOutput.java
@@ -1,89 +1,124 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.manager.SinkOutput.java
- * Created on: Nov 13, 2017
- */
-package fr.bigeon.gclc.manager;
-
-/** A console output that absorbs every message.
- *
- * @author Emmanuel Bigeon */
-public final class SinkOutput implements ConsoleOutput {
-
- /** The sink output. */
- public static final ConsoleOutput INSTANCE = new SinkOutput();
-
- /** Singleton constructor. */
- private SinkOutput() {
- //
- }
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#close() */
- @Override
- public void close() {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
- @Override
- public boolean isClosed() {
- return false;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
- @Override
- public void print(final String text) {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
- @Override
- public void println() {
- //
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String)
- */
- @Override
- public void println(final String message) {
- //
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.SinkOutput.java
+ * Created on: Nov 13, 2017
+ */
+package fr.bigeon.gclc.utils;
+
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+/** A console output that absorbs every message.
+ *
+ * @author Emmanuel Bigeon */
+public final class SinkOutput implements ConsoleOutput {
+
+ /** The sink output. */
+ public static final ConsoleOutput INSTANCE = new SinkOutput();
+
+ /** Singleton constructor. */
+ private SinkOutput() {
+ //
+ }
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#close() */
+ @Override
+ public void close() {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#isClosed() */
+ @Override
+ public boolean isClosed() {
+ return false;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#print(java.lang.String) */
+ @Override
+ public void print(final String text) {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#println() */
+ @Override
+ public void println() {
+ //
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleOutput#println(java.lang.String)
+ */
+ @Override
+ public void println(final String message) {
+ //
+ }
+
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/StreamConsoleInput.java b/gclc/src/main/java/fr/bigeon/gclc/utils/StreamConsoleInput.java
similarity index 76%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/StreamConsoleInput.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/StreamConsoleInput.java
index ff56edc..eb42ce2 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/StreamConsoleInput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/StreamConsoleInput.java
@@ -1,190 +1,224 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.system.SystemConsoleManager.java
- * Created on: Dec 19, 2014
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.PrintStream;
-import java.nio.charset.Charset;
-
-import fr.bigeon.gclc.tools.ConstantString;
-import fr.bigeon.gclc.tools.StringProvider;
-
-/** A console using the input stream and print stream.
- *
- * The default constructor will use the system standart input and output.
- *
- * @author Emmanuel BIGEON */
-public final class StreamConsoleInput implements ConsoleInput {
-
- /** The default prompt. */
- public static final StringProvider DEFAULT_PROMPT = new ConstantString("> "); //$NON-NLS-1$
-
- /** The command prompt. It can be changed. */
- private StringProvider prompt = DEFAULT_PROMPT;
-
- /** The print stream. */
- private final PrintStream out;
- /** The input stream. */
- private final BufferedReader in;
-
- /** If the manager is closed. */
- private boolean closed = false;
-
- /** The prompting thread. */
- private final Thread promptThread;
-
- /** The reading runnable. */
- private final ReadingRunnable reading;
-
- /** This default constructor relies on the system defined standart output
- * and input stream. */
- public StreamConsoleInput() {
- this(System.out, System.in, Charset.defaultCharset());
- }
-
- /** Create the stream base console input.
- *
- * @param out the output stream
- * @param in the input stream
- * @param charset the charset for the input */
- public StreamConsoleInput(final PrintStream out, final InputStream in,
- final Charset charset) {
- super();
- this.out = out;
- this.in = new BufferedReader(new InputStreamReader(in, charset));
- reading = new ReadingRunnable(this.in);
- promptThread = new Thread(reading, "prompt"); //$NON-NLS-1$
- promptThread.setDaemon(true);
- promptThread.start();
- }
-
- /** Check that the console input is not closed.
- *
- * @throws IOException if the stream was closed */
- private void checkOpen() throws IOException {
- if (closed) {
- throw new IOException();
- }
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#close() */
- @Override
- public void close() throws IOException {
- closed = true;
- reading.setRunning(false);
- promptThread.interrupt();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
- @Override
- public StringProvider getPrompt() {
- return prompt;
- }
-
- /** Beware, in this implementation this is the same as closing the manager.
- *
- * @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
- @Override
- public void interruptPrompt() {
- reading.interrupt();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
- @Override
- public boolean isClosed() {
- return closed;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.ConsoleManager#prompt() */
- @Override
- public String prompt() throws IOException {
- return prompt(prompt.apply());
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
- @Override
- public String prompt(final long timeout) throws IOException {
- return prompt(prompt.apply(), timeout);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
- @Override
- public String prompt(final String message) throws IOException {
- checkOpen();
- if (out != null) {
- out.print(message);
- out.flush();
- }
- return reading.getMessage();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
- @Override
- public String prompt(final String message,
- final long timeout) throws IOException {
- checkOpen();
- if (out != null) {
- out.print(message);
- out.flush();
- }
- return reading.getNextMessage(timeout);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
- @Override
- public void setPrompt(final String prompt) {
- this.prompt = new ConstantString(prompt);
- }
-
- @Override
- public void setPrompt(StringProvider string) {
- this.prompt = string;
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.system.SystemConsoleManager.java
+ * Created on: Dec 19, 2014
+ */
+package fr.bigeon.gclc.utils;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.PrintStream;
+import java.nio.charset.Charset;
+
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.tools.ConstantString;
+import fr.bigeon.gclc.tools.StringProvider;
+
+/** A console using the input stream and print stream.
+ *
+ * The default constructor will use the system standart input and output.
+ *
+ * @author Emmanuel BIGEON */
+public final class StreamConsoleInput implements ConsoleInput {
+
+ /** The default prompt. */
+ public static final StringProvider DEFAULT_PROMPT = new ConstantString("> "); //$NON-NLS-1$
+
+ /** The command prompt. It can be changed. */
+ private StringProvider prompt = DEFAULT_PROMPT;
+
+ /** The print stream. */
+ private final PrintStream out;
+ /** The input stream. */
+ private final BufferedReader in;
+
+ /** If the manager is closed. */
+ private boolean closed = false;
+
+ /** The prompting thread. */
+ private final Thread promptThread;
+
+ /** The reading runnable. */
+ private final ReadingRunnable reading;
+
+ /** This default constructor relies on the system defined standart output
+ * and input stream. */
+ public StreamConsoleInput() {
+ this(System.out, System.in, Charset.defaultCharset());
+ }
+
+ /** Create the stream base console input.
+ *
+ * @param out the output stream
+ * @param in the input stream
+ * @param charset the charset for the input */
+ public StreamConsoleInput(final PrintStream out, final InputStream in,
+ final Charset charset) {
+ super();
+ this.out = out;
+ this.in = new BufferedReader(new InputStreamReader(in, charset));
+ reading = new ReadingRunnable(this.in);
+ promptThread = new Thread(reading, "prompt"); //$NON-NLS-1$
+ promptThread.setDaemon(true);
+ promptThread.start();
+ }
+
+ /** Check that the console input is not closed.
+ *
+ * @throws IOException if the stream was closed */
+ private void checkOpen() throws IOException {
+ if (closed) {
+ throw new IOException();
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#close() */
+ @Override
+ public void close() throws IOException {
+ closed = true;
+ reading.setRunning(false);
+ promptThread.interrupt();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#getPrompt() */
+ @Override
+ public StringProvider getPrompt() {
+ return prompt;
+ }
+
+ /** Beware, in this implementation this is the same as closing the manager.
+ *
+ * @see fr.bigeon.gclc.manager.ConsoleInput#interruptPrompt() */
+ @Override
+ public void interruptPrompt() {
+ reading.interrupt();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
+ @Override
+ public boolean isClosed() {
+ return closed;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.ConsoleManager#prompt() */
+ @Override
+ public String prompt() throws IOException {
+ return prompt(prompt.apply());
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#prompt(long) */
+ @Override
+ public String prompt(final long timeout) throws IOException {
+ return prompt(prompt.apply(), timeout);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
+ @Override
+ public String prompt(final String message) throws IOException {
+ checkOpen();
+ if (out != null) {
+ out.print(message);
+ out.flush();
+ }
+ return reading.getMessage();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.ConsoleManager#prompt(java.lang.String) */
+ @Override
+ public String prompt(final String message,
+ final long timeout) throws IOException {
+ checkOpen();
+ if (out != null) {
+ out.print(message);
+ out.flush();
+ }
+ return reading.getNextMessage(timeout);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String) */
+ @Override
+ public void setPrompt(final String prompt) {
+ this.prompt = new ConstantString(prompt);
+ }
+
+ @Override
+ public void setPrompt(StringProvider string) {
+ this.prompt = string;
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/StreamConsoleOutput.java b/gclc/src/main/java/fr/bigeon/gclc/utils/StreamConsoleOutput.java
similarity index 67%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/StreamConsoleOutput.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/StreamConsoleOutput.java
index cbe6639..07ba265 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/StreamConsoleOutput.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/StreamConsoleOutput.java
@@ -1,115 +1,150 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.system.SystemConsoleManager.java
- * Created on: Dec 19, 2014
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.IOException;
-import java.io.PrintStream;
-
-/** A console using the input stream and print stream.
- *
- * The default constructor will use the system standart input and output.
- *
- * @author Emmanuel BIGEON */
-public final class StreamConsoleOutput implements ConsoleOutput {
- /** The print stream. */
- private final PrintStream out;
- /** If the manager is closed. */
- private boolean closed = false;
-
- /** This default constructor relies on the system defined standart output
- * and input stream. */
- public StreamConsoleOutput() {
- this(System.out);
- }
-
- /** Create a print stream based console output.
- *
- * @param out the output stream */
- public StreamConsoleOutput(final PrintStream out) {
- super();
- this.out = out;
- }
-
- /** Check the open status.
- *
- * @throws IOException if the stream was closed */
- private void checkOpen() throws IOException {
- if (closed) {
- throw new IOException();
- }
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#close() */
- @Override
- public void close() {
- closed = true;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
- @Override
- public boolean isClosed() {
- return closed;
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.ConsoleManager#print(java.lang.Object) */
- @Override
- public void print(final String object) throws IOException {
- checkOpen();
- out.print(object);
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.ConsoleManager#println() */
- @Override
- public void println() throws IOException {
- checkOpen();
- out.println();
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.ConsoleManager#println(java.lang.Object) */
- @Override
- public void println(final String object) throws IOException {
- checkOpen();
- out.println(object);
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.system.SystemConsoleManager.java
+ * Created on: Dec 19, 2014
+ */
+package fr.bigeon.gclc.utils;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+import java.io.PrintStream;
+
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** A console using the input stream and print stream.
+ *
+ * The default constructor will use the system standart input and output.
+ *
+ * @author Emmanuel BIGEON */
+public final class StreamConsoleOutput implements ConsoleOutput {
+ /** The print stream. */
+ private final PrintStream out;
+ /** If the manager is closed. */
+ private boolean closed = false;
+
+ /** This default constructor relies on the system defined standart output
+ * and input stream. */
+ public StreamConsoleOutput() {
+ this(System.out);
+ }
+
+ /** Create a print stream based console output.
+ *
+ * @param out the output stream */
+ public StreamConsoleOutput(final PrintStream out) {
+ super();
+ this.out = out;
+ }
+
+ /** Check the open status.
+ *
+ * @throws IOException if the stream was closed */
+ private void checkOpen() throws IOException {
+ if (closed) {
+ throw new IOException();
+ }
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#close() */
+ @Override
+ public void close() {
+ closed = true;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.manager.ConsoleManager#isClosed() */
+ @Override
+ public boolean isClosed() {
+ return closed;
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.ConsoleManager#print(java.lang.Object) */
+ @Override
+ public void print(final String object) throws IOException {
+ checkOpen();
+ out.print(object);
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.ConsoleManager#println() */
+ @Override
+ public void println() throws IOException {
+ checkOpen();
+ out.println();
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.ConsoleManager#println(java.lang.Object) */
+ @Override
+ public void println(final String object) throws IOException {
+ checkOpen();
+ out.println(object);
+ }
+}
diff --git a/gclc/src/main/java/fr/bigeon/gclc/manager/WritingRunnable.java b/gclc/src/main/java/fr/bigeon/gclc/utils/WritingRunnable.java
similarity index 74%
rename from gclc/src/main/java/fr/bigeon/gclc/manager/WritingRunnable.java
rename to gclc/src/main/java/fr/bigeon/gclc/utils/WritingRunnable.java
index 34107db..1a32aef 100644
--- a/gclc/src/main/java/fr/bigeon/gclc/manager/WritingRunnable.java
+++ b/gclc/src/main/java/fr/bigeon/gclc/utils/WritingRunnable.java
@@ -1,160 +1,193 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.test.utils.WritingRunnable.java
- * Created on: Nov 29, 2016
- */
-package fr.bigeon.gclc.manager;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-import java.nio.charset.Charset;
-import java.util.ArrayDeque;
-import java.util.Deque;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-/** The runnable in charge of writing messages as they are read.
- *
- * Messages are queued to be retrieved latter on.
- *
- * @author Emmanuel Bigeon */
-public final class WritingRunnable implements Runnable {
-
- /** Wait timeout. */
- private static final long TIMEOUT = 1000;
- /** Class logger. */
- private static final Logger LOGGER = Logger
- .getLogger(WritingRunnable.class.getName());
- /** Messages to write. */
- private final Deque
+ * Messages are queued to be retrieved latter on.
+ *
+ * @author Emmanuel Bigeon */
+public final class WritingRunnable implements Runnable {
+
+ /** Wait timeout. */
+ private static final long TIMEOUT = 1000;
+ /** Class logger. */
+ private static final Logger LOGGER = Logger
+ .getLogger(WritingRunnable.class.getName());
+ /** Messages to write. */
+ private final Deque
- * TODO
- *
- * @author Emmanuel Bigeon
- *
- */
-@SuppressWarnings("javadoc")
-public class CommandTestingApplication implements AutoCloseable {
-
- private final ConsoleApplication application;
- private final Thread th;
- private final PipedConsoleOutput out;
- private final PipedConsoleInput in;
-
- /** @throws IOException if the streams cannot be build */
- public CommandTestingApplication() throws IOException {
- out = new PipedConsoleOutput();
- in = new PipedConsoleInput(null);
- application = new ConsoleApplication(out, in, "", "");
- new ConsoleTestApplication().attach(application);
- th = new Thread(new Runnable() {
-
- @SuppressWarnings("synthetic-access")
- @Override
- public void run() {
- application.start();
- }
- });
-
- th.start();
- }
-
- /** @param cmd the command
- * @return if the command was added
- * @throws InvalidCommandName if the command name is invalid
- * @see fr.bigeon.gclc.ConsoleApplication#add(fr.bigeon.gclc.command.ICommand) */
- public final boolean add(final ICommand cmd) throws InvalidCommandName {
- return application.add(cmd);
- }
-
- @Override
- public void close() throws IOException {
- application.exit();
- out.close();
- in.close();
- }
-
- /** @return the application */
- public ConsoleApplication getApplication() {
- return application;
- }
-
- /** @return the next written line, null if it is the prompt
- * @throws IOException if the reading failed */
- public String readNextLine() throws IOException {
- final String ret = out.readNextLine();
- return ret;
- }
-
- public void sendCommand(final String cmd) throws IOException {
- in.type(cmd);
- }
-
- /** @throws IOException if the writing failed */
- public void waitAndStop() throws IOException {
- in.type(ConsoleTestApplication.EXIT);
- try {
- th.join();
- } catch (final InterruptedException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.CommandTestingApplication.java
+ * Created on: Jun 12, 2016
+ */
+package fr.bigeon.gclc;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+
+import fr.bigeon.gclc.command.ICommand;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+import fr.bigeon.gclc.utils.PipedConsoleInput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon
+ *
+ */
+@SuppressWarnings("javadoc")
+public class CommandTestingApplication implements AutoCloseable {
+
+ private final ConsoleApplication application;
+ private final Thread th;
+ private final PipedConsoleOutput out;
+ private final PipedConsoleInput in;
+
+ /** @throws IOException if the streams cannot be build */
+ public CommandTestingApplication() throws IOException {
+ out = new PipedConsoleOutput();
+ in = new PipedConsoleInput(null);
+ application = new ConsoleApplication(out, in, "", "");
+ new ConsoleTestApplication().attach(application);
+ th = new Thread(new Runnable() {
+
+ @SuppressWarnings("synthetic-access")
+ @Override
+ public void run() {
+ application.start();
+ }
+ });
+
+ th.start();
+ }
+
+ /** @param cmd the command
+ * @return if the command was added
+ * @throws InvalidCommandName if the command name is invalid
+ * @see fr.bigeon.gclc.ConsoleApplication#add(fr.bigeon.gclc.command.ICommand) */
+ public final boolean add(final ICommand cmd) throws InvalidCommandName {
+ return application.add(cmd);
+ }
+
+ @Override
+ public void close() throws IOException {
+ application.exit();
+ out.close();
+ in.close();
+ }
+
+ /** @return the application */
+ public ConsoleApplication getApplication() {
+ return application;
+ }
+
+ /** @return the next written line, null if it is the prompt
+ * @throws IOException if the reading failed */
+ public String readNextLine() throws IOException {
+ final String ret = out.readNextLine();
+ return ret;
+ }
+
+ public void sendCommand(final String cmd) throws IOException {
+ in.type(cmd);
+ }
+
+ /** @throws IOException if the writing failed */
+ public void waitAndStop() throws IOException {
+ in.type(ConsoleTestApplication.EXIT);
+ try {
+ th.join();
+ } catch (final InterruptedException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/ConsoleApplicationTest.java b/gclc/src/test/java/fr/bigeon/gclc/ConsoleApplicationTest.java
index 008d2ca..571d5bd 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/ConsoleApplicationTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/ConsoleApplicationTest.java
@@ -1,247 +1,279 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.ConsoleApplicationTest.java
- * Created on: Jun 9, 2016
- */
-package fr.bigeon.gclc;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.command.ExitCommand;
-import fr.bigeon.gclc.command.ICommand;
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.CommandRunExceptionType;
-import fr.bigeon.gclc.exception.InvalidCommandName;
-import fr.bigeon.gclc.i18n.Messages;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-import fr.bigeon.gclc.manager.PipedConsoleInput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/** Test class for ConsoleApplication
- *
- * @author Emmanuel Bigeon */
-@SuppressWarnings({"javadoc", "nls", "static-method"})
-public class ConsoleApplicationTest {
-
- /** 3 seconds in milliseconds */
- protected static final long THREE_SECONDS = 3000;
-
- /** Test the base of a console application */
- @Test
- public void testConsoleApplication() {
-
- try (PipedOutputStream pout = new PipedOutputStream();
- PipedInputStream pis = new PipedInputStream(pout);
- BufferedReader buf = new BufferedReader(
- new InputStreamReader(pis, StandardCharsets.UTF_8));
- PipedConsoleInput in = new PipedConsoleInput(
- new PrintStream(pout))) {
- final ConsoleApplication app = new ConsoleApplication(null, in,
- "", "");
- app.exit();
- } catch (final IOException e) {
- fail("System Console Manager failed");
- }
-
- }
-
- @Test
- public void testExecution() throws IOException, InterruptedException,
- InvalidCommandName {
- try (CommandTestingApplication application = new CommandTestingApplication()) {
-
- // remove welcome
- assertEquals("Header should be preserved",
- application.getApplication().header,
- application.readNextLine());
- // Remove first prompt
- application.sendCommand("");
- application.sendCommand("test");
- assertEquals("Test should run", "Test command ran fine",
- application.readNextLine());
- application.sendCommand("toto");
- assertEquals("Command fail should dispaly appropriate message",
- Messages.getString("ConsoleApplication.cmd.failed", "toto"),
- application.readNextLine());
- assertEquals(
- "Unrecognized comment should result in a specific message.",
- Messages.getString("CommandProvider.unrecognized", "toto"),
- application.readNextLine());
- application.sendCommand("long");
- assertEquals("Before wait should receive message", "Waita minute",
- application.readNextLine());
- assertEquals("Unexpected message", "done!",
- application.readNextLine());
-
- final CommandRequestListener crl = new CommandRequestListener() {
-
- @Override
- public void commandRequest(final String command) {
- //
- }
- };
- final CommandRequestListener crl2 = new CommandRequestListener() {
-
- @Override
- public void commandRequest(final String command) {
- //
- }
- };
- application.getApplication().addListener(crl);
- application.getApplication().addListener(crl2);
- application.sendCommand("test");
- assertEquals("Unexpected message", "Test command ran fine",
- application.readNextLine());
- application.getApplication().removeListener(crl2);
- application.getApplication().removeListener(crl);
- application.getApplication().removeListener(crl);
-
- assertTrue("Unclosed application should be running",
- application.getApplication().isRunning());
-
- application.sendCommand("exit");
- assertEquals("Footer should be preserved",
- application.getApplication().footer,
- application.readNextLine());
- assertFalse("Stopped application should not be running",
- application.getApplication().isRunning());
- }
-
- ConsoleApplication appli = null;
- try (PipedConsoleOutput manager = new PipedConsoleOutput();
- PipedOutputStream pout = new PipedOutputStream();
- PipedInputStream pis = new PipedInputStream(pout);
- BufferedReader buf = new BufferedReader(
- new InputStreamReader(pis, StandardCharsets.UTF_8));
- PipedConsoleInput in = new PipedConsoleInput(
- new PrintStream(pout))) {
- final ConsoleApplication app = new ConsoleApplication(manager, in,
- null, null);
- appli = app;
- app.add(new ExitCommand("exit", app));
-
- final Thread th = new Thread(new Runnable() {
-
- @SuppressWarnings("synthetic-access")
- @Override
- public void run() {
- app.start();
- }
- });
- th.start();
- in.type("exit");
- th.join();
- }
-
- assertNotNull(
- "Application should still exist even if the console input and output are closed.",
- appli);
- appli.start();
- assertFalse(
- "Application should not start on closed console input and output",
- appli.isRunning());
- }
-
- @Test
- public void testInterpretCommand() throws InvalidCommandName, IOException {
- try (PipedConsoleInput test = new PipedConsoleInput(null);
- PipedConsoleOutput out = new PipedConsoleOutput()) {
- final ConsoleApplication appl = new ConsoleApplication(out, test,
- "", "");
-
- appl.interpretCommand("invalid cmd \"due to misplaced\"quote");
- assertEquals("Specific error message expected",
- "Command line cannot be parsed", out.readNextLine());
-
- appl.interpretCommand("");
-
- final String message = "message";
- appl.add(new ICommand() {
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
- * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
- * java.lang.String[]) */
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- throw new CommandRunException(CommandRunExceptionType.USAGE,
- message, this);
- }
-
- @Override
- public String getCommandName() {
- return "fail";
- }
-
- @Override
- public void help(final ConsoleOutput manager,
- final String... args) throws IOException {
- manager.println(message);
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- });
- appl.interpretCommand("fail");
- assertEquals("Unexpected message",
- Messages.getString("ConsoleApplication.cmd.failed", "fail"),
- out.readNextLine());
- assertEquals("Unexpected message", message, out.readNextLine());
- assertEquals("Unexpected message", message, out.readNextLine());
-
- }
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.ConsoleApplicationTest.java
+ * Created on: Jun 9, 2016
+ */
+package fr.bigeon.gclc;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.command.ICommand;
+import fr.bigeon.gclc.command.base.ExitCommand;
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.CommandRunExceptionType;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+import fr.bigeon.gclc.i18n.Messages;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+import fr.bigeon.gclc.utils.PipedConsoleInput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/** Test class for ConsoleApplication
+ *
+ * @author Emmanuel Bigeon */
+@SuppressWarnings({"javadoc", "nls", "static-method"})
+public class ConsoleApplicationTest {
+
+ /** 3 seconds in milliseconds */
+ protected static final long THREE_SECONDS = 3000;
+
+ /** Test the base of a console application */
+ @Test
+ public void testConsoleApplication() {
+
+ try (PipedOutputStream pout = new PipedOutputStream();
+ PipedInputStream pis = new PipedInputStream(pout);
+ BufferedReader buf = new BufferedReader(
+ new InputStreamReader(pis, StandardCharsets.UTF_8));
+ PipedConsoleInput in = new PipedConsoleInput(
+ new PrintStream(pout))) {
+ final ConsoleApplication app = new ConsoleApplication(null, in,
+ "", "");
+ app.exit();
+ } catch (final IOException e) {
+ fail("System Console Manager failed");
+ }
+
+ }
+
+ @Test
+ public void testExecution() throws IOException, InterruptedException,
+ InvalidCommandName {
+ try (CommandTestingApplication application = new CommandTestingApplication()) {
+
+ // remove welcome
+ assertEquals("Header should be preserved",
+ application.getApplication().header,
+ application.readNextLine());
+ // Remove first prompt
+ application.sendCommand("");
+ application.sendCommand("test");
+ assertEquals("Test should run", "Test command ran fine",
+ application.readNextLine());
+ application.sendCommand("toto");
+ assertEquals("Command fail should dispaly appropriate message",
+ Messages.getString("ConsoleApplication.cmd.failed", "toto"),
+ application.readNextLine());
+ assertEquals(
+ "Unrecognized comment should result in a specific message.",
+ Messages.getString("CommandProvider.unrecognized", "toto"),
+ application.readNextLine());
+ application.sendCommand("long");
+ assertEquals("Before wait should receive message", "Waita minute",
+ application.readNextLine());
+ assertEquals("Unexpected message", "done!",
+ application.readNextLine());
+
+ final CommandRequestListener crl = new CommandRequestListener() {
+
+ @Override
+ public void commandRequest(final String command) {
+ //
+ }
+ };
+ final CommandRequestListener crl2 = new CommandRequestListener() {
+
+ @Override
+ public void commandRequest(final String command) {
+ //
+ }
+ };
+ application.getApplication().addListener(crl);
+ application.getApplication().addListener(crl2);
+ application.sendCommand("test");
+ assertEquals("Unexpected message", "Test command ran fine",
+ application.readNextLine());
+ application.getApplication().removeListener(crl2);
+ application.getApplication().removeListener(crl);
+ application.getApplication().removeListener(crl);
+
+ assertTrue("Unclosed application should be running",
+ application.getApplication().isRunning());
+
+ application.sendCommand("exit");
+ assertEquals("Footer should be preserved",
+ application.getApplication().footer,
+ application.readNextLine());
+ assertFalse("Stopped application should not be running",
+ application.getApplication().isRunning());
+ }
+
+ ConsoleApplication appli = null;
+ try (PipedConsoleOutput manager = new PipedConsoleOutput();
+ PipedOutputStream pout = new PipedOutputStream();
+ PipedInputStream pis = new PipedInputStream(pout);
+ BufferedReader buf = new BufferedReader(
+ new InputStreamReader(pis, StandardCharsets.UTF_8));
+ PipedConsoleInput in = new PipedConsoleInput(
+ new PrintStream(pout))) {
+ final ConsoleApplication app = new ConsoleApplication(manager, in,
+ null, null);
+ appli = app;
+ app.add(new ExitCommand("exit", app));
+
+ final Thread th = new Thread(new Runnable() {
+
+ @Override
+ public void run() {
+ app.start();
+ }
+ });
+ th.start();
+ in.type("exit");
+ th.join();
+ }
+
+ assertNotNull(
+ "Application should still exist even if the console input and output are closed.",
+ appli);
+ appli.start();
+ assertFalse(
+ "Application should not start on closed console input and output",
+ appli.isRunning());
+ }
+
+ @Test
+ public void testInterpretCommand() throws InvalidCommandName, IOException {
+ try (PipedConsoleInput test = new PipedConsoleInput(null);
+ PipedConsoleOutput out = new PipedConsoleOutput()) {
+ final ConsoleApplication appl = new ConsoleApplication(out, test,
+ "", "");
+
+ appl.interpretCommand("invalid cmd \"due to misplaced\"quote");
+ assertEquals("Specific error message expected",
+ "Command line cannot be parsed", out.readNextLine());
+
+ appl.interpretCommand("");
+
+ final String message = "message";
+ appl.add(new ICommand() {
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
+ * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
+ * java.lang.String[]) */
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ throw new CommandRunException(CommandRunExceptionType.USAGE,
+ message);
+ }
+
+ @Override
+ public String getCommandName() {
+ return "fail";
+ }
+
+ @Override
+ public void help(final ConsoleOutput manager,
+ final String... args) throws IOException {
+ manager.println(message);
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ });
+ appl.interpretCommand("fail");
+ assertEquals("Unexpected message",
+ Messages.getString("ConsoleApplication.cmd.failed", "fail"),
+ out.readNextLine());
+ assertEquals("Unexpected message", message, out.readNextLine());
+ assertEquals("Unexpected message", message, out.readNextLine());
+
+ }
+ }
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/ConsoleTestApplication.java b/gclc/src/test/java/fr/bigeon/gclc/ConsoleTestApplication.java
index bb9d655..fe8ee7f 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/ConsoleTestApplication.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/ConsoleTestApplication.java
@@ -1,152 +1,179 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-package fr.bigeon.gclc;
-
-import java.io.IOException;
-
-import fr.bigeon.gclc.command.Command;
-import fr.bigeon.gclc.command.ExitCommand;
-import fr.bigeon.gclc.command.HelpExecutor;
-import fr.bigeon.gclc.command.ICommandProvider;
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.InvalidCommandName;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-
-/** A test-purpose application
- *
- * @author Emmanuel Bigeon */
-public class ConsoleTestApplication implements ApplicationAttachement {
-
- /** Exit command */
- public static final String EXIT = "exit"; //$NON-NLS-1$
- /** Two seconds in milliseconds */
- protected static final long TWO_SECONDS = 2000;
-
- /***/
- @Override
- @SuppressWarnings("nls")
- public void attach(final ICommandProvider application) {
- try {
- application.add(new ExitCommand(EXIT, (ConsoleApplication) application));
- application.add(new HelpExecutor("help",
- ((ConsoleApplication) application).root));
- application.add(new Command("test") {
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
- * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
- * java.lang.String[]) */
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- try {
- out.println("Test command ran fine");
- } catch (final IOException e) {
- throw new CommandRunException("manager closed", e,
- this);
- }
- }
-
- @Override
- public String tip() {
- return "A test command";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- });
- application.add(new Command("long") {
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
- * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
- * java.lang.String[]) */
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- try {
- out.println("Waita minute");
- Thread.sleep(TWO_SECONDS);
- out.println("done!");
- } catch (final IOException e) {
- throw new CommandRunException("manager closed", e,
- this);
- } catch (final InterruptedException e) {
- throw new CommandRunException("wait interrupted", e,
- this);
- }
- }
-
- @Override
- public String tip() {
- return "A long execution command";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- });
- application.add(new Command("failingCmd") {
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
- * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
- * java.lang.String[]) */
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- throw new CommandRunException("Failing command", this);
- }
-
- @Override
- public String tip() {
- return "A long execution command";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- });
- } catch (final InvalidCommandName e) {
- e.printStackTrace();
- }
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+package fr.bigeon.gclc;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import java.io.IOException;
+
+import fr.bigeon.gclc.command.Command;
+import fr.bigeon.gclc.command.HelpExecutor;
+import fr.bigeon.gclc.command.ICommandProvider;
+import fr.bigeon.gclc.command.base.ExitCommand;
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+
+/** A test-purpose application
+ *
+ * @author Emmanuel Bigeon */
+public class ConsoleTestApplication implements ApplicationAttachement {
+
+ /** Exit command */
+ public static final String EXIT = "exit"; //$NON-NLS-1$
+ /** Two seconds in milliseconds */
+ protected static final long TWO_SECONDS = 2000;
+
+ /***/
+ @Override
+ @SuppressWarnings("nls")
+ public void attach(final ICommandProvider application) {
+ try {
+ application.add(new ExitCommand(EXIT, (ConsoleApplication) application));
+ application.add(
+ new HelpExecutor("help", ((ConsoleApplication) application).root));
+ application.add(new Command("test") {
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
+ * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
+ * java.lang.String[]) */
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ try {
+ out.println("Test command ran fine");
+ } catch (final IOException e) {
+ throw new CommandRunException("manager closed", e);
+ }
+ }
+
+ @Override
+ public String tip() {
+ return "A test command";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ });
+ application.add(new Command("long") {
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
+ * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
+ * java.lang.String[]) */
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ try {
+ out.println("Waita minute");
+ Thread.sleep(TWO_SECONDS);
+ out.println("done!");
+ } catch (final IOException e) {
+ throw new CommandRunException("manager closed", e);
+ } catch (final InterruptedException e) {
+ throw new CommandRunException("wait interrupted", e);
+ }
+ }
+
+ @Override
+ public String tip() {
+ return "A long execution command";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ });
+ application.add(new Command("failingCmd") {
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.ICommand#execute(fr.bigeon.gclc.
+ * manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput,
+ * java.lang.String[]) */
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ throw new CommandRunException("Failing command");
+ }
+
+ @Override
+ public String tip() {
+ return "A long execution command";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ });
+ } catch (final InvalidCommandName e) {
+ e.printStackTrace();
+ }
+ }
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/GCLCConstantsTest.java b/gclc/src/test/java/fr/bigeon/gclc/GCLCConstantsTest.java
index 850c485..1abbc07 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/GCLCConstantsTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/GCLCConstantsTest.java
@@ -1,128 +1,161 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.GCLCConstantsTest.java
- * Created on: Jun 8, 2016
- */
-package fr.bigeon.gclc;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-
-import java.util.List;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.exception.CommandParsingException;
-
-/** Test class for {@link GCLCConstants}
- *
- * @author Emmanuel Bigeon */
-@SuppressWarnings({"nls", "static-method"})
-public class GCLCConstantsTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.GCLCConstants#splitCommand(java.lang.String)}.
- *
- * @throws CommandParsingException if an error occured */
- @Test
- public void testSplitCommand() throws CommandParsingException {
- List
- * TODO
- *
- * @author Emmanuel Bigeon */
-@SuppressWarnings({"static-method", "nls"})
-public class CommandParametersTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.CommandParameters#CommandParameters(java.util.Set, java.util.Set, boolean)}.
- *
- * @throws CommandParsingException if an unexpected exception is thrown */
- @Test
- public final void testCommandParameters() throws CommandParsingException {
- final Set
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+@SuppressWarnings({"static-method", "nls"})
+public class CommandParametersTest {
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.CommandParameters#CommandParameters(java.util.Set, java.util.Set, boolean)}.
+ *
+ * @throws CommandParsingException if an unexpected exception is thrown */
+ @Test
+ public final void testCommandParameters() throws CommandParsingException {
+ final Set
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class CommandProviderTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.CommandProvider#add(fr.bigeon.gclc.command.ICommand)}.
- *
- * @throws InvalidCommandName if the test failed */
- @Test
- public final void testAdd() throws InvalidCommandName {
- final CommandProvider provider = new CommandProvider();
- try {
- provider.add(new MockCommand(null));
- fail("null name for command should be rejected");
- } catch (final InvalidCommandName e) {
- // ok
- }
- try {
- provider.add(new MockCommand(""));
- fail("null name for command should be rejected");
- } catch (final InvalidCommandName e) {
- // ok
- }
- try {
- provider.add(new MockCommand("-name"));
- fail("name with minus as starting character for command should be rejected");
- } catch (final InvalidCommandName e) {
- // ok
- }
- try {
- provider.add(new MockCommand("name command"));
- fail("name with space for command should be rejected");
- } catch (final InvalidCommandName e) {
- // ok
- }
- final ICommand mock = new MockCommand("name");
- provider.add(mock);
-
- try {
- provider.add(new MockCommand(mock.getCommandName()));
- fail("already existing command name should be rejected");
- } catch (final InvalidCommandName e) {
- // ok
- }
-
- provider.add(mock);
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.CommandProviderTest.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.fail;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.command.base.MockCommand;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class CommandProviderTest {
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.CommandProvider#add(fr.bigeon.gclc.command.ICommand)}.
+ *
+ * @throws InvalidCommandName if the test failed */
+ @Test
+ public final void testAdd() throws InvalidCommandName {
+ final CommandProvider provider = new CommandProvider();
+ try {
+ provider.add(new MockCommand(null));
+ fail("null name for command should be rejected");
+ } catch (final InvalidCommandName e) {
+ // ok
+ }
+ try {
+ provider.add(new MockCommand(""));
+ fail("null name for command should be rejected");
+ } catch (final InvalidCommandName e) {
+ // ok
+ }
+ try {
+ provider.add(new MockCommand("-name"));
+ fail("name with minus as starting character for command should be rejected");
+ } catch (final InvalidCommandName e) {
+ // ok
+ }
+ try {
+ provider.add(new MockCommand("name command"));
+ fail("name with space for command should be rejected");
+ } catch (final InvalidCommandName e) {
+ // ok
+ }
+ final ICommand mock = new MockCommand("name");
+ provider.add(mock);
+
+ try {
+ provider.add(new MockCommand(mock.getCommandName()));
+ fail("already existing command name should be rejected");
+ } catch (final InvalidCommandName e) {
+ // ok
+ }
+
+ provider.add(mock);
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/command/CommandTest.java b/gclc/src/test/java/fr/bigeon/gclc/command/CommandTest.java
index 3ad8b50..f71f5c8 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/command/CommandTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/command/CommandTest.java
@@ -1,376 +1,409 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.CommandTest.java
- * Created on: Nov 19, 2016
- */
-package fr.bigeon.gclc.command;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
-
-import java.io.IOException;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/**
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class CommandTest {
-
- @Test
- public final void testCommand() throws IOException {
- try (PipedConsoleOutput test = new PipedConsoleOutput()) {
- Command cmd;
- cmd = new Command("name") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.help(test);
-
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // details
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.help(test);
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // details
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#brief() */
- @Override
- protected String brief() {
- return null;
- }
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.help(test);
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // details
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#brief() */
- @Override
- protected String brief() {
- return "brief";
- }
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.help(test);
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // details
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#usageDetail() */
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.help(test);
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // details
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#usageDetail() */
- @Override
- protected String usageDetail() {
- return "details";
- }
- };
- cmd.help(test);
-
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // pattern
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // details
- assertEquals("Unexpected detail", "details", test.readNextLine());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#usageDetail() */
- @Override
- protected String usageDetail() {
- return "details" + System.lineSeparator();
- }
- };
- cmd.help(test);
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // pattern
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // details
- assertEquals("Unexpected detail", "details", test.readNextLine());
- assertFalse("Only 6 line should be printed", test.available());
-
- cmd = new Command("name") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
-
- /* (non-Javadoc)
- * @see fr.bigeon.gclc.command.Command#usageDetail() */
- @Override
- protected String usageDetail() {
- return "\n";
- }
- };
- cmd.help(test);
- // name
- assertEquals("First line should be command name", "name",
- test.readNextLine());
- // tip
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- // Usage
- test.readNextLine();
- // pattern
- test.readNextLine();
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- //
- assertTrue("Section line is empty", test.readNextLine().isEmpty());
- assertFalse("Only 6 line should be printed", test.available());
-
- }
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.CommandTest.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/**
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class CommandTest {
+
+ @Test
+ public final void testCommand() throws IOException {
+ try (PipedConsoleOutput test = new PipedConsoleOutput()) {
+ Command cmd;
+ cmd = new Command("name") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.help(test);
+
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // details
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.help(test);
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // details
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#brief() */
+ @Override
+ protected String brief() {
+ return null;
+ }
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.help(test);
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // details
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#brief() */
+ @Override
+ protected String brief() {
+ return "brief";
+ }
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.help(test);
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // details
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#usageDetail() */
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.help(test);
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // details
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#usageDetail() */
+ @Override
+ protected String usageDetail() {
+ return "details";
+ }
+ };
+ cmd.help(test);
+
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // pattern
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // details
+ assertEquals("Unexpected detail", "details", test.readNextLine());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#usageDetail() */
+ @Override
+ protected String usageDetail() {
+ return "details" + System.lineSeparator();
+ }
+ };
+ cmd.help(test);
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // pattern
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // details
+ assertEquals("Unexpected detail", "details", test.readNextLine());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ cmd = new Command("name") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+
+ /* (non-Javadoc)
+ * @see fr.bigeon.gclc.command.Command#usageDetail() */
+ @Override
+ protected String usageDetail() {
+ return "\n";
+ }
+ };
+ cmd.help(test);
+ // name
+ assertEquals("First line should be command name", "name",
+ test.readNextLine());
+ // tip
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ // Usage
+ test.readNextLine();
+ // pattern
+ test.readNextLine();
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ //
+ assertTrue("Section line is empty", test.readNextLine().isEmpty());
+ assertFalse("Only 6 line should be printed", test.available());
+
+ }
+ }
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/command/HelpExecutorTest.java b/gclc/src/test/java/fr/bigeon/gclc/command/HelpExecutorTest.java
index 8bbf59e..b4c0c03 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/command/HelpExecutorTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/command/HelpExecutorTest.java
@@ -1,118 +1,152 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.HelpExecutorTest.java
- * Created on: Nov 19, 2016
- */
-package fr.bigeon.gclc.command;
-
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.fail;
-
-import java.io.IOException;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class HelpExecutorTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.HelpExecutor#execute(ConsoleOutput, ConsoleInput, String...)}.
- *
- * @throws CommandRunException if the test failed
- * @throws IOException if the test failed */
- @Test
- public final void testExecute() throws CommandRunException, IOException {
- final PipedConsoleOutput test = new PipedConsoleOutput();
- final HelpExecutor help = new HelpExecutor("?", new Command("mock") {
-
- @Override
- public void execute(final ConsoleOutput out, final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
-
- });
-
- help.execute(test, null);
- test.close();
-
- try {
- help.execute(test, null);
- fail("manager closed shall provoke failure of help command execution");
- } catch (final Exception e) {
- // ok
- }
- }
-
- /** Test method for {@link fr.bigeon.gclc.command.HelpExecutor#tip()}.
- *
- * @throws IOException if the test failed */
- @Test
- public final void testTip() throws IOException {
- try (PipedConsoleOutput test = new PipedConsoleOutput()) {
- final HelpExecutor help = new HelpExecutor("?",
- new MockCommand("mock"));
- assertNotNull("Tip should be provided", help.tip());
- help.help(test);
- }
- try (PipedConsoleOutput test = new PipedConsoleOutput()) {
- final HelpExecutor help = new HelpExecutor("?",
- new SubedCommand("sub", new MockCommand("mock")));
- help.tip();
- help.help(test);
- }
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.HelpExecutorTest.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.command.base.MockCommand;
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class HelpExecutorTest {
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.HelpExecutor#execute(ConsoleOutput, ConsoleInput, String...)}.
+ *
+ * @throws CommandRunException if the test failed
+ * @throws IOException if the test failed */
+ @Test
+ public final void testExecute() throws CommandRunException, IOException {
+ final PipedConsoleOutput test = new PipedConsoleOutput();
+ final HelpExecutor help = new HelpExecutor("?", new Command("mock") {
+
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+
+ });
+
+ help.execute(test, null);
+ test.close();
+
+ try {
+ help.execute(test, null);
+ fail("manager closed shall provoke failure of help command execution");
+ } catch (final Exception e) {
+ // ok
+ }
+ }
+
+ /** Test method for {@link fr.bigeon.gclc.command.HelpExecutor#tip()}.
+ *
+ * @throws IOException if the test failed */
+ @Test
+ public final void testTip() throws IOException {
+ try (PipedConsoleOutput test = new PipedConsoleOutput()) {
+ final HelpExecutor help = new HelpExecutor("?",
+ new MockCommand("mock"));
+ assertNotNull("Tip should be provided", help.tip());
+ help.help(test);
+ }
+ try (PipedConsoleOutput test = new PipedConsoleOutput()) {
+ final HelpExecutor help = new HelpExecutor("?",
+ new SubedCommand("sub", new MockCommand("mock")));
+ help.tip();
+ help.help(test);
+ }
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/command/ParametrizedCommandTest.java b/gclc/src/test/java/fr/bigeon/gclc/command/ParametrizedCommandTest.java
index a1d0ea7..d87b05c 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/command/ParametrizedCommandTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/command/ParametrizedCommandTest.java
@@ -1,682 +1,714 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.ParametrizedCommandTest.java
- * Created on: Nov 18, 2016
- */
-package fr.bigeon.gclc.command;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.InvalidParameterException;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-import fr.bigeon.gclc.manager.PipedConsoleInput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class ParametrizedCommandTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.ParametrizedCommand#addStringParameter(String, boolean)}.
- *
- * @throws InvalidParameterException if the test failed */
- @Test
- public final void testAddParameter() throws InvalidParameterException {
- ParametrizedCommand cmd = new ParametrizedCommand("name") {
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd = new ParametrizedCommand("name", true) {
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- // XXX Boolean flag should not be specified mandatory! They are by
- // nature qualified
- final String str = "str";
- assertTrue(cmd.getBooleanParameters().isEmpty());
- assertTrue(cmd.getStringParameters().isEmpty());
- cmd.addBooleanParameter("boolFlag");
- assertEquals(1, cmd.getBooleanParameters().size());
- assertTrue(cmd.getStringParameters().isEmpty());
- cmd.addStringParameter(str, false);
- assertEquals(1, cmd.getBooleanParameters().size());
- assertEquals(1, cmd.getStringParameters().size());
- assertFalse(cmd.isNeeded(str));
- cmd.addBooleanParameter("boolFlag");
- assertEquals(1, cmd.getBooleanParameters().size());
- assertEquals(1, cmd.getStringParameters().size());
- cmd.addStringParameter(str, true);
- assertEquals(1, cmd.getBooleanParameters().size());
- assertEquals(1, cmd.getStringParameters().size());
- assertTrue(cmd.isNeeded(str));
- cmd.addStringParameter(str, false);
- assertEquals(1, cmd.getBooleanParameters().size());
- assertEquals(1, cmd.getStringParameters().size());
- assertTrue(cmd.isNeeded(str));
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.ParametrizedCommand#execute(ConsoleOutput, ConsoleInput, String...)}.
- *
- * @throws CommandRunException if the test failed
- * @throws InterruptedException if the test failed
- * @throws IOException if the test failed */
- @Test
- public final void testExecute() throws CommandRunException,
- InterruptedException, IOException {
- final String addParam = "additional";
- final String str1 = "str1";
- final String str2 = "str2";
- final String bool1 = "bool1";
- final String bool2 = "bool2";
-
- // Test on command with no needed elements
- ParametrizedCommand cmd = new ParametrizedCommand("name", false) {
- private boolean evenCall = true;
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- assertTrue(parameters.getBooleanArgumentKeys().isEmpty());
- assertTrue(parameters.getStringArgumentKeys().isEmpty());
- if (evenCall) {
- assertTrue(parameters.getAdditionals().isEmpty());
- evenCall = false;
- } else {
- assertEquals(1, parameters.getAdditionals().size());
- assertTrue(parameters.getAdditionals().contains(addParam));
- evenCall = true;
- }
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.execute(null, null);
- cmd.execute(null, null, addParam);
- cmd = new ParametrizedCommand("name", false) {
- private int call = 0;
- {
-
- try {
- addStringParameter(str1, false);
- addStringParameter(str2, false);
- addBooleanParameter(bool1);
- addBooleanParameter(bool2);
- } catch (final InvalidParameterException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- assertEquals(2, parameters.getBooleanArgumentKeys().size());
- assertEquals(2, parameters.getStringArgumentKeys().size());
- switch (call) {
- case 0:
- case 1:
- case 2:
- case 3:
- assertNull(parameters.get(str1));
- assertNull(parameters.get(str2));
- assertFalse(parameters.getBool(bool1));
- assertFalse(parameters.getBool(bool2));
- call++;
- break;
- case 4:
- assertEquals(str2, parameters.get(str1));
- assertNull(parameters.get(str2));
- assertFalse(parameters.getBool(bool1));
- assertFalse(parameters.getBool(bool2));
- call++;
- break;
- case 5:
- assertEquals(str2, parameters.get(str1));
- assertNull(parameters.get(str2));
- assertTrue(parameters.getBool(bool1));
- assertFalse(parameters.getBool(bool2));
- call = 0;
- break;
- default:
- break;
- }
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.execute(null, null);
- cmd.execute(null, null, "-" + addParam);
- cmd.execute(null, null, addParam);
- cmd.execute(null, null, "-" + addParam, addParam);
- cmd.execute(null, null, "-" + str1, str2);
- cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
- cmd = new ParametrizedCommand("name", true) {
- private int call = 0;
- {
-
- try {
- addStringParameter(str1, false);
- addStringParameter(str2, false);
- addBooleanParameter(bool1);
- addBooleanParameter(bool2);
- } catch (final InvalidParameterException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- assertEquals(2, parameters.getBooleanArgumentKeys().size());
- assertEquals(2, parameters.getStringArgumentKeys().size());
- switch (call) {
- case 0:
- assertNull(parameters.get(str1));
- assertNull(parameters.get(str2));
- assertFalse(parameters.getBool(bool1));
- assertFalse(parameters.getBool(bool2));
- call++;
- break;
- case 1:
- assertEquals(str2, parameters.get(str1));
- assertNull(parameters.get(str2));
- assertFalse(parameters.getBool(bool1));
- assertFalse(parameters.getBool(bool2));
- call++;
- break;
- case 2:
- assertEquals(str2, parameters.get(str1));
- assertNull(parameters.get(str2));
- assertTrue(parameters.getBool(bool1));
- assertFalse(parameters.getBool(bool2));
- call = 0;
- break;
- default:
- break;
- }
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.execute(null, null);
- cmd.execute(null, null, "-" + str1, str2);
- cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
- try {
- cmd.execute(null, null, addParam);
- fail("Strict should fail with unexpected argument");
- } catch (final CommandRunException e) {
- // ok
- }
- try {
- cmd.execute(null, null, "-" + addParam);
- fail("Strict should fail with unexpected argument");
- } catch (final CommandRunException e) {
- // ok
- }
- // Test on command with missing needed elements
- cmd = new ParametrizedCommand("name", false) {
- private final int call = 0;
- {
-
- try {
- addStringParameter(str1, true);
- addStringParameter(str2, false);
- addBooleanParameter(bool1);
- addBooleanParameter(bool2);
- } catch (final InvalidParameterException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- assertEquals(str2, parameters.get(str1));
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.execute(null, null, "-" + str1, str2);
- cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
- cmd.execute(null, null, "-" + str1, str2, "-" + addParam);
- cmd.execute(null, null, "-" + str1, str2, addParam);
- cmd.execute(null, null, "-" + str1, str2, "-" + addParam, addParam);
- try {
- cmd.execute(null, null);
- fail("needed " + str1 + " not provided shall fail");
- } catch (final CommandRunException e) {
- // ok
- }
- cmd = new ParametrizedCommand("name", true) {
- private final int call = 0;
- {
-
- try {
- addStringParameter(str1, true);
- addStringParameter(str2, false);
- addBooleanParameter(bool1);
- addBooleanParameter(bool2);
- } catch (final InvalidParameterException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- assertEquals(str2, parameters.get(str1));
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- cmd.execute(null, null, "-" + str1, str2);
- cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
- try {
- cmd.execute(null, null, "-" + str1, str2, addParam);
- fail("Additional parameter should cause failure");
- } catch (final CommandRunException e) {
- // ok
- }
- try {
- cmd.execute(null, null);
- fail("needed " + str1 + " not provided shall fail");
- } catch (final CommandRunException e) {
- // ok
- }
- try {
- cmd.execute(null, null, "-" + str1, str2, "-" + addParam);
- fail("unepected error");
- } catch (final CommandRunException e) {
- // ok
- }
- try {
- cmd.execute(null, null, "-" + str1, str2, "-" + addParam, addParam);
- fail("unepected error");
- } catch (final CommandRunException e) {
- // ok
- }
- // TODO Test of interactive not providing and providing all needed
- }
-
- @Test
- public void testExecuteInteractive() throws IOException,
- CommandRunException,
- InterruptedException {
- ParametrizedCommand cmd;
- final String addParam = "additional";
- final String str1 = "str1";
- final String str2 = "str2";
- final String bool1 = "bool1";
- final String bool2 = "bool2";
-
- cmd = new ParametrizedCommand("name", false) {
- {
- try {
- addStringParameter(str1, true);
- addStringParameter(str2, false);
- addBooleanParameter(bool1);
- addBooleanParameter(bool2);
- } catch (final InvalidParameterException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) throws CommandRunException {
- if (!str2.equals(parameters.get(str1))) {
- throw new CommandRunException("Expected other argument",
- this);
- }
- }
-
- @Override
- public String tip() {
- return "";
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- try (PipedConsoleOutput out = new PipedConsoleOutput();
- PipedOutputStream pout = new PipedOutputStream();
- PipedInputStream pis = new PipedInputStream(pout);
- BufferedReader buf = new BufferedReader(
- new InputStreamReader(pis, StandardCharsets.UTF_8));
- PipedConsoleInput in = new PipedConsoleInput(
- new PrintStream(pout))) {
- cmd.execute(out, in, "-" + str1, str2);
- cmd.execute(out, in, "-" + str1, str2, "-" + bool1);
- cmd.execute(out, in, "-" + str1, str2, addParam);
- cmd.execute(out, in, "-" + str1, str2, "-" + addParam);
- cmd.execute(out, in, "-" + str1, str2, "-" + addParam, addParam);
-
- final Thread th = new Thread(new Runnable() {
-
- @Override
- public void run() {
- try {
- assertEquals("value of " + str1 + "? ", buf.readLine());
- in.type("");
- assertEquals(
- "value of " + str1 + "? (cannot be empty) ",
- buf.readLine());
- in.type("");
- assertEquals(
- "value of " + str1 + "? (cannot be empty) ",
- buf.readLine());
- in.type(str2);
- } catch (final IOException e) {
- assertNull(e);
- }
- }
- });
- th.start();
-
- cmd.execute(out, in);
-
- th.join();
- }
- try (PipedConsoleOutput out = new PipedConsoleOutput();
- PipedOutputStream pout = new PipedOutputStream();
- PipedInputStream pis = new PipedInputStream(pout);
- BufferedReader buf = new BufferedReader(
- new InputStreamReader(pis, StandardCharsets.UTF_8));
- PipedConsoleInput in = new PipedConsoleInput(
- new PrintStream(pout))) {
-
- final Thread th = new Thread(new Runnable() {
-
- @Override
- public void run() {
- try {
- assertEquals("value of " + str1 + "? ", buf.readLine());
- in.type(str2);
- } catch (final IOException e) {
- assertNull(e);
- }
- }
- });
- th.start();
-
- cmd.execute(out, in, "-" + addParam);
-
- th.join();
- }
- try {
- final PipedConsoleOutput out = new PipedConsoleOutput();
- final PipedConsoleInput test = new PipedConsoleInput(null);
- test.close();
- out.close();
- cmd.execute(out, test, "-" + str1, str2);
- cmd.execute(out, test, "-" + addParam);
- fail("Closed manager shall cause error");
- } catch (final CommandRunException e) {
- // ok
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.ParametrizedCommand#ParametrizedCommand(String)}. */
- @Test
- public final void testParametrizedCommandConsoleManagerString() {
- ParametrizedCommand cmd = new ParametrizedCommand("name") {
-
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- assertTrue(cmd.isStrict());
- cmd = new ParametrizedCommand("name") {
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- assertTrue(cmd.isStrict());
- cmd = new ParametrizedCommand("name") {
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- assertTrue(cmd.isStrict());
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.ParametrizedCommand#ParametrizedCommand(java.lang.String, boolean)}. */
- @Test
- public final void testParametrizedCommandConsoleManagerStringBoolean() {
- ParametrizedCommand cmd = new ParametrizedCommand("name", false) {
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- assertFalse(cmd.isStrict());
- cmd = new ParametrizedCommand("name", false) {
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- assertFalse(cmd.isStrict());
- cmd = new ParametrizedCommand("name", false) {
- @Override
- protected void doExecute(final ConsoleOutput out,
- final ConsoleInput in,
- final CommandParameters parameters) {
- //
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- };
- assertFalse(cmd.isStrict());
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.ParametrizedCommandTest.java
+ * Created on: Nov 18, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.StandardCharsets;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.InvalidParameterException;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+import fr.bigeon.gclc.utils.PipedConsoleInput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class ParametrizedCommandTest {
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.ParametrizedCommand#addStringParameter(String, boolean)}.
+ *
+ * @throws InvalidParameterException if the test failed */
+ @Test
+ public final void testAddParameter() throws InvalidParameterException {
+ ParametrizedCommand cmd = new ParametrizedCommand("name") {
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd = new ParametrizedCommand("name", true) {
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ // XXX Boolean flag should not be specified mandatory! They are by
+ // nature qualified
+ final String str = "str";
+ assertTrue(cmd.getBooleanParameters().isEmpty());
+ assertTrue(cmd.getStringParameters().isEmpty());
+ cmd.addBooleanParameter("boolFlag");
+ assertEquals(1, cmd.getBooleanParameters().size());
+ assertTrue(cmd.getStringParameters().isEmpty());
+ cmd.addStringParameter(str, false);
+ assertEquals(1, cmd.getBooleanParameters().size());
+ assertEquals(1, cmd.getStringParameters().size());
+ assertFalse(cmd.isNeeded(str));
+ cmd.addBooleanParameter("boolFlag");
+ assertEquals(1, cmd.getBooleanParameters().size());
+ assertEquals(1, cmd.getStringParameters().size());
+ cmd.addStringParameter(str, true);
+ assertEquals(1, cmd.getBooleanParameters().size());
+ assertEquals(1, cmd.getStringParameters().size());
+ assertTrue(cmd.isNeeded(str));
+ cmd.addStringParameter(str, false);
+ assertEquals(1, cmd.getBooleanParameters().size());
+ assertEquals(1, cmd.getStringParameters().size());
+ assertTrue(cmd.isNeeded(str));
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.ParametrizedCommand#execute(ConsoleOutput, ConsoleInput, String...)}.
+ *
+ * @throws CommandRunException if the test failed
+ * @throws InterruptedException if the test failed
+ * @throws IOException if the test failed */
+ @Test
+ public final void testExecute() throws CommandRunException,
+ InterruptedException, IOException {
+ final String addParam = "additional";
+ final String str1 = "str1";
+ final String str2 = "str2";
+ final String bool1 = "bool1";
+ final String bool2 = "bool2";
+
+ // Test on command with no needed elements
+ ParametrizedCommand cmd = new ParametrizedCommand("name", false) {
+ private boolean evenCall = true;
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ assertTrue(parameters.getBooleanArgumentKeys().isEmpty());
+ assertTrue(parameters.getStringArgumentKeys().isEmpty());
+ if (evenCall) {
+ assertTrue(parameters.getAdditionals().isEmpty());
+ evenCall = false;
+ } else {
+ assertEquals(1, parameters.getAdditionals().size());
+ assertTrue(parameters.getAdditionals().contains(addParam));
+ evenCall = true;
+ }
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.execute(null, null);
+ cmd.execute(null, null, addParam);
+ cmd = new ParametrizedCommand("name", false) {
+ private int call = 0;
+ {
+
+ try {
+ addStringParameter(str1, false);
+ addStringParameter(str2, false);
+ addBooleanParameter(bool1);
+ addBooleanParameter(bool2);
+ } catch (final InvalidParameterException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ assertEquals(2, parameters.getBooleanArgumentKeys().size());
+ assertEquals(2, parameters.getStringArgumentKeys().size());
+ switch (call) {
+ case 0:
+ case 1:
+ case 2:
+ case 3:
+ assertNull(parameters.get(str1));
+ assertNull(parameters.get(str2));
+ assertFalse(parameters.getBool(bool1));
+ assertFalse(parameters.getBool(bool2));
+ call++;
+ break;
+ case 4:
+ assertEquals(str2, parameters.get(str1));
+ assertNull(parameters.get(str2));
+ assertFalse(parameters.getBool(bool1));
+ assertFalse(parameters.getBool(bool2));
+ call++;
+ break;
+ case 5:
+ assertEquals(str2, parameters.get(str1));
+ assertNull(parameters.get(str2));
+ assertTrue(parameters.getBool(bool1));
+ assertFalse(parameters.getBool(bool2));
+ call = 0;
+ break;
+ default:
+ break;
+ }
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.execute(null, null);
+ cmd.execute(null, null, "-" + addParam);
+ cmd.execute(null, null, addParam);
+ cmd.execute(null, null, "-" + addParam, addParam);
+ cmd.execute(null, null, "-" + str1, str2);
+ cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
+ cmd = new ParametrizedCommand("name", true) {
+ private int call = 0;
+ {
+
+ try {
+ addStringParameter(str1, false);
+ addStringParameter(str2, false);
+ addBooleanParameter(bool1);
+ addBooleanParameter(bool2);
+ } catch (final InvalidParameterException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ assertEquals(2, parameters.getBooleanArgumentKeys().size());
+ assertEquals(2, parameters.getStringArgumentKeys().size());
+ switch (call) {
+ case 0:
+ assertNull(parameters.get(str1));
+ assertNull(parameters.get(str2));
+ assertFalse(parameters.getBool(bool1));
+ assertFalse(parameters.getBool(bool2));
+ call++;
+ break;
+ case 1:
+ assertEquals(str2, parameters.get(str1));
+ assertNull(parameters.get(str2));
+ assertFalse(parameters.getBool(bool1));
+ assertFalse(parameters.getBool(bool2));
+ call++;
+ break;
+ case 2:
+ assertEquals(str2, parameters.get(str1));
+ assertNull(parameters.get(str2));
+ assertTrue(parameters.getBool(bool1));
+ assertFalse(parameters.getBool(bool2));
+ call = 0;
+ break;
+ default:
+ break;
+ }
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.execute(null, null);
+ cmd.execute(null, null, "-" + str1, str2);
+ cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
+ try {
+ cmd.execute(null, null, addParam);
+ fail("Strict should fail with unexpected argument");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ try {
+ cmd.execute(null, null, "-" + addParam);
+ fail("Strict should fail with unexpected argument");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ // Test on command with missing needed elements
+ cmd = new ParametrizedCommand("name", false) {
+ private final int call = 0;
+ {
+
+ try {
+ addStringParameter(str1, true);
+ addStringParameter(str2, false);
+ addBooleanParameter(bool1);
+ addBooleanParameter(bool2);
+ } catch (final InvalidParameterException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ assertEquals(str2, parameters.get(str1));
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.execute(null, null, "-" + str1, str2);
+ cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
+ cmd.execute(null, null, "-" + str1, str2, "-" + addParam);
+ cmd.execute(null, null, "-" + str1, str2, addParam);
+ cmd.execute(null, null, "-" + str1, str2, "-" + addParam, addParam);
+ try {
+ cmd.execute(null, null);
+ fail("needed " + str1 + " not provided shall fail");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ cmd = new ParametrizedCommand("name", true) {
+ private final int call = 0;
+ {
+
+ try {
+ addStringParameter(str1, true);
+ addStringParameter(str2, false);
+ addBooleanParameter(bool1);
+ addBooleanParameter(bool2);
+ } catch (final InvalidParameterException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ assertEquals(str2, parameters.get(str1));
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ cmd.execute(null, null, "-" + str1, str2);
+ cmd.execute(null, null, "-" + str1, str2, "-" + bool1);
+ try {
+ cmd.execute(null, null, "-" + str1, str2, addParam);
+ fail("Additional parameter should cause failure");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ try {
+ cmd.execute(null, null);
+ fail("needed " + str1 + " not provided shall fail");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ try {
+ cmd.execute(null, null, "-" + str1, str2, "-" + addParam);
+ fail("unepected error");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ try {
+ cmd.execute(null, null, "-" + str1, str2, "-" + addParam, addParam);
+ fail("unepected error");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ // TODO Test of interactive not providing and providing all needed
+ }
+
+ @Test
+ public void testExecuteInteractive() throws IOException,
+ CommandRunException,
+ InterruptedException {
+ ParametrizedCommand cmd;
+ final String addParam = "additional";
+ final String str1 = "str1";
+ final String str2 = "str2";
+ final String bool1 = "bool1";
+ final String bool2 = "bool2";
+
+ cmd = new ParametrizedCommand("name", false) {
+ {
+ try {
+ addStringParameter(str1, true);
+ addStringParameter(str2, false);
+ addBooleanParameter(bool1);
+ addBooleanParameter(bool2);
+ } catch (final InvalidParameterException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) throws CommandRunException {
+ if (!str2.equals(parameters.get(str1))) {
+ throw new CommandRunException("Expected other argument");
+ }
+ }
+
+ @Override
+ public String tip() {
+ return "";
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ try (PipedConsoleOutput out = new PipedConsoleOutput();
+ PipedOutputStream pout = new PipedOutputStream();
+ PipedInputStream pis = new PipedInputStream(pout);
+ BufferedReader buf = new BufferedReader(
+ new InputStreamReader(pis, StandardCharsets.UTF_8));
+ PipedConsoleInput in = new PipedConsoleInput(
+ new PrintStream(pout))) {
+ cmd.execute(out, in, "-" + str1, str2);
+ cmd.execute(out, in, "-" + str1, str2, "-" + bool1);
+ cmd.execute(out, in, "-" + str1, str2, addParam);
+ cmd.execute(out, in, "-" + str1, str2, "-" + addParam);
+ cmd.execute(out, in, "-" + str1, str2, "-" + addParam, addParam);
+
+ final Thread th = new Thread(new Runnable() {
+
+ @Override
+ public void run() {
+ try {
+ assertEquals("value of " + str1 + "? ", buf.readLine());
+ in.type("");
+ assertEquals(
+ "value of " + str1 + "? (cannot be empty) ",
+ buf.readLine());
+ in.type("");
+ assertEquals(
+ "value of " + str1 + "? (cannot be empty) ",
+ buf.readLine());
+ in.type(str2);
+ } catch (final IOException e) {
+ assertNull(e);
+ }
+ }
+ });
+ th.start();
+
+ cmd.execute(out, in);
+
+ th.join();
+ }
+ try (PipedConsoleOutput out = new PipedConsoleOutput();
+ PipedOutputStream pout = new PipedOutputStream();
+ PipedInputStream pis = new PipedInputStream(pout);
+ BufferedReader buf = new BufferedReader(
+ new InputStreamReader(pis, StandardCharsets.UTF_8));
+ PipedConsoleInput in = new PipedConsoleInput(
+ new PrintStream(pout))) {
+
+ final Thread th = new Thread(new Runnable() {
+
+ @Override
+ public void run() {
+ try {
+ assertEquals("value of " + str1 + "? ", buf.readLine());
+ in.type(str2);
+ } catch (final IOException e) {
+ assertNull(e);
+ }
+ }
+ });
+ th.start();
+
+ cmd.execute(out, in, "-" + addParam);
+
+ th.join();
+ }
+ try {
+ final PipedConsoleOutput out = new PipedConsoleOutput();
+ final PipedConsoleInput test = new PipedConsoleInput(null);
+ test.close();
+ out.close();
+ cmd.execute(out, test, "-" + str1, str2);
+ cmd.execute(out, test, "-" + addParam);
+ fail("Closed manager shall cause error");
+ } catch (final CommandRunException e) {
+ // ok
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.ParametrizedCommand#ParametrizedCommand(String)}. */
+ @Test
+ public final void testParametrizedCommandConsoleManagerString() {
+ ParametrizedCommand cmd = new ParametrizedCommand("name") {
+
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ assertTrue(cmd.isStrict());
+ cmd = new ParametrizedCommand("name") {
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ assertTrue(cmd.isStrict());
+ cmd = new ParametrizedCommand("name") {
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ assertTrue(cmd.isStrict());
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.ParametrizedCommand#ParametrizedCommand(java.lang.String, boolean)}. */
+ @Test
+ public final void testParametrizedCommandConsoleManagerStringBoolean() {
+ ParametrizedCommand cmd = new ParametrizedCommand("name", false) {
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ assertFalse(cmd.isStrict());
+ cmd = new ParametrizedCommand("name", false) {
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ assertFalse(cmd.isStrict());
+ cmd = new ParametrizedCommand("name", false) {
+ @Override
+ protected void doExecute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final CommandParameters parameters) {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ };
+ assertFalse(cmd.isStrict());
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/command/ScriptExecutionTest.java b/gclc/src/test/java/fr/bigeon/gclc/command/ScriptExecutionTest.java
index 8b4f90b..1b35f7e 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/command/ScriptExecutionTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/command/ScriptExecutionTest.java
@@ -1,181 +1,209 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.ScriptExecutionTest.java
- * Created on: Jun 12, 2016
- */
-package fr.bigeon.gclc.command;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.fail;
-
-import java.io.IOException;
-import java.nio.charset.Charset;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.ConsoleApplication;
-import fr.bigeon.gclc.ConsoleTestApplication;
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.CommandRunExceptionType;
-import fr.bigeon.gclc.manager.PipedConsoleInput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/**
- * Test class for {@link ScriptExecution}
- *
- * @author Emmanuel Bigeon */
-@SuppressWarnings("static-method")
-public class ScriptExecutionTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.ScriptExecution#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, String...)}. */
- @Test
- public void testExecute() {
- PipedConsoleOutput test;
- PipedConsoleInput in;
- try {
- in = new PipedConsoleInput(null);
- test = new PipedConsoleOutput();
- } catch (final IOException e2) {
- fail("creation of console manager failed"); //$NON-NLS-1$
- return;
- }
- final ConsoleApplication app = new ConsoleApplication(
- test, in, "", "");
- new ConsoleTestApplication().attach(app);
- final ScriptExecution exec = new ScriptExecution("script", app, "#", //$NON-NLS-1$ //$NON-NLS-2$
- Charset.forName("UTF-8"));
- try {
- exec.execute(test, in);
- fail("execution of script command with no file should fail"); //$NON-NLS-1$
- } catch (final CommandRunException e1) {
- // ok
- assertEquals(exec, e1.getSource());
- assertEquals(CommandRunExceptionType.USAGE, e1.getType());
- }
-
- try {
- exec.execute(test, in,
- "src/test/resources/scripts/withprependSpace.txt"); //$NON-NLS-1$
- fail("execution of script with lines begining with space should fail"); //$NON-NLS-1$
- } catch (final CommandRunException e1) {
- // ok
- assertEquals(exec, e1.getSource());
- assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
- }
-
- try {
- exec.execute(test, in,
- "src/test/resources/scripts/invalidCmdParse.txt"); //$NON-NLS-1$
- fail("execution of script with invalid command line should fail"); //$NON-NLS-1$
- } catch (final CommandRunException e1) {
- // ok
- assertEquals(exec, e1.getSource());
- assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
- }
-
- try {
- exec.execute(test, in,
- "src/test/resources/scripts/invalidCmd.txt"); //$NON-NLS-1$
- fail("execution of script with invalid command should fail"); //$NON-NLS-1$
- } catch (final CommandRunException e1) {
- // ok
- assertEquals(exec, e1.getSource());
- assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
- }
-
- try {
- exec.execute(test, in,
- "src/test/resources/scripts/failingCmdInvoc.txt"); //$NON-NLS-1$
- fail("execution of script with failing command should fail"); //$NON-NLS-1$
- } catch (final CommandRunException e1) {
- // ok
- assertEquals(exec, e1.getSource());
- assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
- }
-
- try {
- exec.execute(test, in,
- "src/test/resources/scripts/someNonExisting.file"); //$NON-NLS-1$
- fail("execution of script with unexisting file should fail"); //$NON-NLS-1$
- } catch (final CommandRunException e1) {
- // ok
- assertEquals(exec, e1.getSource());
- assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
- }
-
- try {
- exec.execute(test, in, "src/test/resources/script1.txt"); //$NON-NLS-1$
- exec.execute(test, in, "src/test/resources/script2.txt"); //$NON-NLS-1$
- exec.execute(test, in, "src/test/resources/script3.txt"); //$NON-NLS-1$
- exec.execute(test, in, "src/test/resources/script4.txt"); //$NON-NLS-1$
- exec.execute(test, in, "src/test/resources/script5.txt", "test"); //$NON-NLS-1$ //$NON-NLS-2$
- } catch (final CommandRunException e) {
- e.printStackTrace();
- fail("execution of wellformed script should not fail"); //$NON-NLS-1$
- }
- try {
- test.close();
- } catch (final IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.ScriptExecution#help(fr.bigeon.gclc.manager.ConsoleOutput, String...)}. */
- @Test
- public void testHelp() {
- final ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$
- Charset.forName("UTF-8"));
- try (PipedConsoleOutput test = new PipedConsoleOutput()) {
- exec.help(test);
- exec.help(test, "ignored element");
- } catch (final IOException e) {
- e.printStackTrace();
- fail("unexpected error in help invocation"); //$NON-NLS-1$
- }
- }
-
- /** Test method for {@link fr.bigeon.gclc.command.ScriptExecution#tip()}. */
- @Test
- public void testTip() {
- final ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$
- Charset.forName("UTF-8"));
- assertNotNull("Tip should not be null", exec.tip());
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.ScriptExecutionTest.java
+ * Created on: Jun 12, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.ConsoleApplication;
+import fr.bigeon.gclc.ConsoleTestApplication;
+import fr.bigeon.gclc.command.base.ScriptExecution;
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.CommandRunExceptionType;
+import fr.bigeon.gclc.utils.PipedConsoleInput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/**
+ * Test class for {@link ScriptExecution}
+ *
+ * @author Emmanuel Bigeon */
+@SuppressWarnings("static-method")
+public class ScriptExecutionTest {
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.base.ScriptExecution#execute(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, String...)}. */
+ @Test
+ public void testExecute() {
+ PipedConsoleOutput test;
+ PipedConsoleInput in;
+ try {
+ in = new PipedConsoleInput(null);
+ test = new PipedConsoleOutput();
+ } catch (final IOException e2) {
+ fail("creation of console manager failed"); //$NON-NLS-1$
+ return;
+ }
+ final ConsoleApplication app = new ConsoleApplication(
+ test, in, "", "");
+ new ConsoleTestApplication().attach(app);
+ final ScriptExecution exec = new ScriptExecution("script", app, "#", //$NON-NLS-1$ //$NON-NLS-2$
+ Charset.forName("UTF-8"));
+ try {
+ exec.execute(test, in);
+ fail("execution of script command with no file should fail"); //$NON-NLS-1$
+ } catch (final CommandRunException e1) {
+ // ok
+ assertEquals(CommandRunExceptionType.USAGE, e1.getType());
+ }
+
+ try {
+ exec.execute(test, in,
+ "src/test/resources/scripts/withprependSpace.txt"); //$NON-NLS-1$
+ fail("execution of script with lines begining with space should fail"); //$NON-NLS-1$
+ } catch (final CommandRunException e1) {
+ // ok
+ assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
+ }
+
+ try {
+ exec.execute(test, in,
+ "src/test/resources/scripts/invalidCmdParse.txt"); //$NON-NLS-1$
+ fail("execution of script with invalid command line should fail"); //$NON-NLS-1$
+ } catch (final CommandRunException e1) {
+ // ok
+ assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
+ }
+
+ try {
+ exec.execute(test, in,
+ "src/test/resources/scripts/invalidCmd.txt"); //$NON-NLS-1$
+ fail("execution of script with invalid command should fail"); //$NON-NLS-1$
+ } catch (final CommandRunException e1) {
+ // ok
+ assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
+ }
+
+ try {
+ exec.execute(test, in,
+ "src/test/resources/scripts/failingCmdInvoc.txt"); //$NON-NLS-1$
+ fail("execution of script with failing command should fail"); //$NON-NLS-1$
+ } catch (final CommandRunException e1) {
+ // ok
+ assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
+ }
+
+ try {
+ exec.execute(test, in,
+ "src/test/resources/scripts/someNonExisting.file"); //$NON-NLS-1$
+ fail("execution of script with unexisting file should fail"); //$NON-NLS-1$
+ } catch (final CommandRunException e1) {
+ // ok
+ assertEquals(CommandRunExceptionType.EXECUTION, e1.getType());
+ }
+
+ try {
+ exec.execute(test, in, "src/test/resources/script1.gclc"); //$NON-NLS-1$
+ exec.execute(test, in, "src/test/resources/script2.txt"); //$NON-NLS-1$
+ exec.execute(test, in, "src/test/resources/script3.txt"); //$NON-NLS-1$
+ exec.execute(test, in, "src/test/resources/script4.txt"); //$NON-NLS-1$
+ exec.execute(test, in, "src/test/resources/script5.txt", "test"); //$NON-NLS-1$ //$NON-NLS-2$
+ } catch (final CommandRunException e) {
+ e.printStackTrace();
+ fail("execution of wellformed script should not fail"); //$NON-NLS-1$
+ }
+ try {
+ test.close();
+ } catch (final IOException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.base.ScriptExecution#help(fr.bigeon.gclc.manager.ConsoleOutput, String...)}. */
+ @Test
+ public void testHelp() {
+ final ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$
+ Charset.forName("UTF-8"));
+ try (PipedConsoleOutput test = new PipedConsoleOutput()) {
+ exec.help(test);
+ exec.help(test, "ignored element");
+ } catch (final IOException e) {
+ e.printStackTrace();
+ fail("unexpected error in help invocation"); //$NON-NLS-1$
+ }
+ }
+
+ /** Test method for {@link fr.bigeon.gclc.command.base.ScriptExecution#tip()}. */
+ @Test
+ public void testTip() {
+ final ScriptExecution exec = new ScriptExecution("script", null, "#", //$NON-NLS-1$ //$NON-NLS-2$
+ Charset.forName("UTF-8"));
+ assertNotNull("Tip should not be null", exec.tip());
+ }
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/command/SubedCommandTest.java b/gclc/src/test/java/fr/bigeon/gclc/command/SubedCommandTest.java
index bdb40c3..af1752b 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/command/SubedCommandTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/command/SubedCommandTest.java
@@ -1,408 +1,438 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.command.SubedCommandTest.java
- * Created on: Nov 18, 2016
- */
-package fr.bigeon.gclc.command;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.fail;
-
-import java.io.IOException;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.exception.CommandRunException;
-import fr.bigeon.gclc.exception.InvalidCommandName;
-import fr.bigeon.gclc.manager.ConsoleInput;
-import fr.bigeon.gclc.manager.ConsoleOutput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon */
-@SuppressWarnings("all")
-public class SubedCommandTest {
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#add(fr.bigeon.gclc.command.ICommand)}. */
- @Test
- public final void testAdd() {
- final SubedCommand cmd = new SubedCommand("name");
-
- try {
- cmd.add(new MockCommand("id"));
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- }
- try {
- cmd.add(new MockCommand("id"));
- fail("addition of command with already used id succeeded");
- } catch (final InvalidCommandName e) {
- //
- }
- try {
- cmd.add(new MockCommand(""));
- fail("addition of command with invalid id succeeded");
- } catch (final InvalidCommandName e) {
- //
- }
-
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#execute(ConsoleOutput, ConsoleInput, String...)}. */
- @Test
- public final void testExecute() {
- SubedCommand cmd = new SubedCommand("name");
-
- final MockCommand mock = new MockCommand("id");
- try {
- cmd.add(mock);
- cmd.add(new Command("fail") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- throw new CommandRunException("Failing command", null);
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- });
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
-
- try {
- cmd.execute(null, null, "id");
- } catch (final CommandRunException e) {
- fail("Unexpected exception when running mock command");
- assertNotNull(e);
- }
- try {
- cmd.execute(null, null, "fail");
- fail("Fail command error should be re thrown");
- } catch (final CommandRunException e) {
- assertNotNull(e);
- assertEquals(cmd, e.getSource());
- }
- try {
- cmd.execute(null, null);
- fail("Request for inexistent default command should fail");
- } catch (final CommandRunException e) {
- assertNotNull(e);
- assertEquals(cmd, e.getSource());
- }
- cmd = new SubedCommand("name", mock);
-
- try {
- cmd.add(mock);
- cmd.add(new Command("fail") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- throw new CommandRunException("Failing command", this);
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- });
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
-
- try {
- cmd.execute(null, null, "id");
- } catch (final CommandRunException e) {
- fail("Unexpected exception when running mock command");
- assertNotNull(e);
- }
- try {
- cmd.execute(null, null, "fail");
- fail("Fail command error should be re thrown");
- } catch (final CommandRunException e) {
- assertNotNull(e);
- assertEquals(cmd.get("fail"), e.getSource());
- }
- try {
- cmd.execute(null, null);
- } catch (final CommandRunException e) {
- fail("Request for default command should execute default command");
- assertNotNull(e);
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#executeSub(ConsoleOutput, ConsoleInput, String, String...)}. */
- @Test
- public final void testExecuteSub() {
- final SubedCommand cmd = new SubedCommand("name");
-
- final MockCommand mock = new MockCommand("id");
- try {
- cmd.add(mock);
- cmd.add(new Command("fail") {
-
- @Override
- public void execute(final ConsoleOutput out,
- final ConsoleInput in,
- final String... args) throws CommandRunException {
- throw new CommandRunException("Failing command", this);
- }
-
- @Override
- public String tip() {
- return null;
- }
-
- @Override
- protected String usageDetail() {
- return null;
- }
- });
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
-
- try {
- cmd.executeSub(null, null,"id");
- } catch (final CommandRunException e) {
- fail("Unexpected exception when running mock command");
- assertNotNull(e);
- }
- try {
- cmd.executeSub(null, null, "fail");
- fail("Fail command error should be re thrown");
- } catch (final CommandRunException e) {
- assertNotNull(e);
- assertEquals(cmd.get("fail"), e.getSource());
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#get(java.lang.String)}. */
- @Test
- public final void testGet() {
- final SubedCommand cmd = new SubedCommand("name");
-
- assertNull(cmd.get("id"));
-
- final MockCommand mock = new MockCommand("id");
- try {
- cmd.add(mock);
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
- assertEquals(mock, cmd.get("id"));
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#getCommandName()}. */
- @Test
- public final void testGetCommandName() {
- SubedCommand cmd = new SubedCommand("name");
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name with spaces");
- assertEquals("name with spaces", cmd.getCommandName());
- cmd = new SubedCommand("name", "some tip");
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name", new MockCommand(""));
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name", new MockCommand(""), "some tip");
- assertEquals("name", cmd.getCommandName());
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#help(ConsoleOutput, String...)}. */
- @Test
- public final void testHelp() {
- SubedCommand cmd = new SubedCommand("name");
-
- ICommand mock = new MockCommand("id");
- try {
- cmd.add(mock);
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
-
- try (PipedConsoleOutput manager = new PipedConsoleOutput()) {
- cmd.help(manager);
- assertEquals("\tid", manager.readNextLine());
- cmd.help(manager, "id");
- cmd.help(manager, "inexistent");
- } catch (final IOException e) {
- fail("Unexpected exception when running help");
- assertNotNull(e);
- }
-
- cmd = new SubedCommand("name", mock);
-
- try {
- cmd.add(mock);
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
-
- try (PipedConsoleOutput manager = new PipedConsoleOutput()) {
- cmd.help(manager);
- assertEquals("\tid", manager.readNextLine());
- } catch (final IOException e) {
- fail("Unexpected exception when running help");
- assertNotNull(e);
- }
-
- mock = new ICommand() {
-
- @Override
- public void execute(final ConsoleOutput out, final ConsoleInput in,
- final String... args) throws CommandRunException {
- //
- }
-
- @Override
- public String getCommandName() {
- return "id";
- }
-
- @Override
- public void help(final ConsoleOutput manager,
- final String... args) throws IOException {
- //
- }
-
- @Override
- public String tip() {
- return "tip";
- }
- };
- cmd = new SubedCommand("name", mock);
-
- try {
- cmd.add(mock);
- } catch (final InvalidCommandName e) {
- fail("addition of command with valid id failed");
- assertNotNull(e);
- }
-
- try (PipedConsoleOutput manager = new PipedConsoleOutput()) {
- cmd.help(manager);
- assertEquals("\ttip", manager.readNextLine());
- assertEquals("\tid: tip", manager.readNextLine());
- } catch (final IOException e) {
- fail("Unexpected exception when running help");
- assertNotNull(e);
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String)}. */
- @Test
- public final void testSubedCommandString() {
- SubedCommand cmd = new SubedCommand("name");
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name with spaces");
- assertNull(cmd.tip());
- assertEquals("name with spaces", cmd.getCommandName());
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, fr.bigeon.gclc.command.ICommand)}. */
- @Test
- public final void testSubedCommandStringICommand() {
- SubedCommand cmd = new SubedCommand("name", new MockCommand(""));
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name with spaces", new MockCommand(""));
- assertNull(cmd.tip());
- assertEquals("name with spaces", cmd.getCommandName());
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, fr.bigeon.gclc.command.ICommand, java.lang.String)}. */
- @Test
- public final void testSubedCommandStringICommandString() {
- SubedCommand cmd = new SubedCommand("name", new MockCommand(""), "tip");
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name with spaces", new MockCommand(""), "tip");
- assertEquals("name with spaces", cmd.getCommandName());
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, java.lang.String)}. */
- @Test
- public final void testSubedCommandStringString() {
- SubedCommand cmd = new SubedCommand("name", "tip");
- assertEquals("name", cmd.getCommandName());
- cmd = new SubedCommand("name with spaces", "tip");
- assertEquals("name with spaces", cmd.getCommandName());
- }
-
- /** Test method for {@link fr.bigeon.gclc.command.SubedCommand#tip()}. */
- @Test
- public final void testTip() {
- SubedCommand cmd = new SubedCommand("name");
- assertNull(cmd.tip());
- cmd = new SubedCommand("name with spaces", new MockCommand(""), "tip");
- assertEquals("tip", cmd.tip());
- }
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.command.SubedCommandTest.java
+ * Created on: Nov 18, 2016
+ */
+package fr.bigeon.gclc.command;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.command.base.MockCommand;
+import fr.bigeon.gclc.exception.CommandRunException;
+import fr.bigeon.gclc.exception.InvalidCommandName;
+import fr.bigeon.gclc.manager.ConsoleInput;
+import fr.bigeon.gclc.manager.ConsoleOutput;
+import fr.bigeon.gclc.utils.PipedConsoleOutput;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+@SuppressWarnings("all")
+public class SubedCommandTest {
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#add(fr.bigeon.gclc.command.ICommand)}. */
+ @Test
+ public final void testAdd() {
+ final SubedCommand cmd = new SubedCommand("name");
+
+ try {
+ cmd.add(new MockCommand("id"));
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ }
+ try {
+ cmd.add(new MockCommand("id"));
+ fail("addition of command with already used id succeeded");
+ } catch (final InvalidCommandName e) {
+ //
+ }
+ try {
+ cmd.add(new MockCommand(""));
+ fail("addition of command with invalid id succeeded");
+ } catch (final InvalidCommandName e) {
+ //
+ }
+
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#execute(ConsoleOutput, ConsoleInput, String...)}. */
+ @Test
+ public final void testExecute() {
+ SubedCommand cmd = new SubedCommand("name");
+
+ final MockCommand mock = new MockCommand("id");
+ try {
+ cmd.add(mock);
+ cmd.add(new Command("fail") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ throw new CommandRunException("Failing command", null);
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ });
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+
+ try {
+ cmd.execute(null, null, "id");
+ } catch (final CommandRunException e) {
+ fail("Unexpected exception when running mock command");
+ assertNotNull(e);
+ }
+ try {
+ cmd.execute(null, null, "fail");
+ fail("Fail command error should be re thrown");
+ } catch (final CommandRunException e) {
+ assertNotNull(e);
+ }
+ try {
+ cmd.execute(null, null);
+ fail("Request for inexistent default command should fail");
+ } catch (final CommandRunException e) {
+ assertNotNull(e);
+ }
+ cmd = new SubedCommand("name", mock);
+
+ try {
+ cmd.add(mock);
+ cmd.add(new Command("fail") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ throw new CommandRunException("Failing command");
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ });
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+
+ try {
+ cmd.execute(null, null, "id");
+ } catch (final CommandRunException e) {
+ fail("Unexpected exception when running mock command");
+ assertNotNull(e);
+ }
+ try {
+ cmd.execute(null, null, "fail");
+ fail("Fail command error should be re thrown");
+ } catch (final CommandRunException e) {
+ assertNotNull(e);
+ }
+ try {
+ cmd.execute(null, null);
+ } catch (final CommandRunException e) {
+ fail("Request for default command should execute default command");
+ assertNotNull(e);
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#executeSub(ConsoleOutput, ConsoleInput, String, String...)}. */
+ @Test
+ public final void testExecuteSub() {
+ final SubedCommand cmd = new SubedCommand("name");
+
+ final MockCommand mock = new MockCommand("id");
+ try {
+ cmd.add(mock);
+ cmd.add(new Command("fail") {
+
+ @Override
+ public void execute(final ConsoleOutput out,
+ final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ throw new CommandRunException("Failing command");
+ }
+
+ @Override
+ public String tip() {
+ return null;
+ }
+
+ @Override
+ protected String usageDetail() {
+ return null;
+ }
+ });
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+
+ try {
+ cmd.executeSub(null, null,"id");
+ } catch (final CommandRunException e) {
+ fail("Unexpected exception when running mock command");
+ assertNotNull(e);
+ }
+ try {
+ cmd.executeSub(null, null, "fail");
+ fail("Fail command error should be re thrown");
+ } catch (final CommandRunException e) {
+ assertNotNull(e);
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#get(java.lang.String)}. */
+ @Test
+ public final void testGet() {
+ final SubedCommand cmd = new SubedCommand("name");
+
+ assertNull(cmd.get("id"));
+
+ final MockCommand mock = new MockCommand("id");
+ try {
+ cmd.add(mock);
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+ assertEquals(mock, cmd.get("id"));
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#getCommandName()}. */
+ @Test
+ public final void testGetCommandName() {
+ SubedCommand cmd = new SubedCommand("name");
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name with spaces");
+ assertEquals("name with spaces", cmd.getCommandName());
+ cmd = new SubedCommand("name", "some tip");
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name", new MockCommand(""));
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name", new MockCommand(""), "some tip");
+ assertEquals("name", cmd.getCommandName());
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#help(ConsoleOutput, String...)}. */
+ @Test
+ public final void testHelp() {
+ SubedCommand cmd = new SubedCommand("name");
+
+ ICommand mock = new MockCommand("id");
+ try {
+ cmd.add(mock);
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+
+ try (PipedConsoleOutput manager = new PipedConsoleOutput()) {
+ cmd.help(manager);
+ assertEquals("\tid", manager.readNextLine());
+ cmd.help(manager, "id");
+ cmd.help(manager, "inexistent");
+ } catch (final IOException e) {
+ fail("Unexpected exception when running help");
+ assertNotNull(e);
+ }
+
+ cmd = new SubedCommand("name", mock);
+
+ try {
+ cmd.add(mock);
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+
+ try (PipedConsoleOutput manager = new PipedConsoleOutput()) {
+ cmd.help(manager);
+ assertEquals("\tid", manager.readNextLine());
+ } catch (final IOException e) {
+ fail("Unexpected exception when running help");
+ assertNotNull(e);
+ }
+
+ mock = new ICommand() {
+
+ @Override
+ public void execute(final ConsoleOutput out, final ConsoleInput in,
+ final String... args) throws CommandRunException {
+ //
+ }
+
+ @Override
+ public String getCommandName() {
+ return "id";
+ }
+
+ @Override
+ public void help(final ConsoleOutput manager,
+ final String... args) throws IOException {
+ //
+ }
+
+ @Override
+ public String tip() {
+ return "tip";
+ }
+ };
+ cmd = new SubedCommand("name", mock);
+
+ try {
+ cmd.add(mock);
+ } catch (final InvalidCommandName e) {
+ fail("addition of command with valid id failed");
+ assertNotNull(e);
+ }
+
+ try (PipedConsoleOutput manager = new PipedConsoleOutput()) {
+ cmd.help(manager);
+ assertEquals("\ttip", manager.readNextLine());
+ assertEquals("\tid: tip", manager.readNextLine());
+ } catch (final IOException e) {
+ fail("Unexpected exception when running help");
+ assertNotNull(e);
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String)}. */
+ @Test
+ public final void testSubedCommandString() {
+ SubedCommand cmd = new SubedCommand("name");
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name with spaces");
+ assertNull(cmd.tip());
+ assertEquals("name with spaces", cmd.getCommandName());
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, fr.bigeon.gclc.command.ICommand)}. */
+ @Test
+ public final void testSubedCommandStringICommand() {
+ SubedCommand cmd = new SubedCommand("name", new MockCommand(""));
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name with spaces", new MockCommand(""));
+ assertNull(cmd.tip());
+ assertEquals("name with spaces", cmd.getCommandName());
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, fr.bigeon.gclc.command.ICommand, java.lang.String)}. */
+ @Test
+ public final void testSubedCommandStringICommandString() {
+ SubedCommand cmd = new SubedCommand("name", new MockCommand(""), "tip");
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name with spaces", new MockCommand(""), "tip");
+ assertEquals("name with spaces", cmd.getCommandName());
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.command.SubedCommand#SubedCommand(java.lang.String, java.lang.String)}. */
+ @Test
+ public final void testSubedCommandStringString() {
+ SubedCommand cmd = new SubedCommand("name", "tip");
+ assertEquals("name", cmd.getCommandName());
+ cmd = new SubedCommand("name with spaces", "tip");
+ assertEquals("name with spaces", cmd.getCommandName());
+ }
+
+ /** Test method for {@link fr.bigeon.gclc.command.SubedCommand#tip()}. */
+ @Test
+ public final void testTip() {
+ SubedCommand cmd = new SubedCommand("name");
+ assertNull(cmd.tip());
+ cmd = new SubedCommand("name with spaces", new MockCommand(""), "tip");
+ assertEquals("tip", cmd.tip());
+ }
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/exception/CommandRunExceptionTest.java b/gclc/src/test/java/fr/bigeon/gclc/exception/CommandRunExceptionTest.java
index 2a29acc..5930118 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/exception/CommandRunExceptionTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/exception/CommandRunExceptionTest.java
@@ -1,75 +1,107 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.exception.CommandRunExceptionTest.java
- * Created on: Nov 19, 2016
- */
-package fr.bigeon.gclc.exception;
-
-import static org.junit.Assert.assertEquals;
-
-import org.junit.Test;
-
-import fr.bigeon.gclc.command.ICommand;
-import fr.bigeon.gclc.command.MockCommand;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon
- *
- */
-public class CommandRunExceptionTest {
-
- /**
- * Test method for {@link fr.bigeon.gclc.exception.CommandRunException#getLocalizedMessage()}.
- */
- @Test
- public final void testGetLocalizedMessage() {
- CommandRunException e;
- ICommand cmd = new MockCommand("name");
- String messageInner = "inner";
- String message = "message";
- e = new CommandRunException(message,
- new CommandRunException(messageInner, new MockCommand("name")), //$NON-NLS-1$
- cmd);
-
- assertEquals(message + ": " + messageInner, e.getLocalizedMessage());
- e = new CommandRunException(message, cmd);
- assertEquals(message, e.getLocalizedMessage());
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.exception.CommandRunExceptionTest.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.exception;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.command.ICommand;
+import fr.bigeon.gclc.command.base.MockCommand;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon
+ *
+ */
+public class CommandRunExceptionTest {
+
+ /**
+ * Test method for {@link fr.bigeon.gclc.exception.CommandRunException#getLocalizedMessage()}.
+ */
+ @Test
+ public final void testGetLocalizedMessage() {
+ CommandRunException e;
+ final ICommand cmd = new MockCommand("name");
+ final String messageInner = "inner";
+ final String message = "message";
+ e = new CommandRunException(message,
+ new CommandRunException(messageInner));
+
+ assertEquals(message + ": " + messageInner, e.getLocalizedMessage());
+ e = new CommandRunException(message);
+ assertEquals(message, e.getLocalizedMessage());
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/manager/ReadingRunnableTest.java b/gclc/src/test/java/fr/bigeon/gclc/manager/ReadingRunnableTest.java
index 4dfae41..da5258d 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/manager/ReadingRunnableTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/manager/ReadingRunnableTest.java
@@ -1,142 +1,177 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.manager.ReadingRunnableTest.java
- * Created on: Dec 6, 2016
- */
-package fr.bigeon.gclc.manager;
-
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.fail;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.nio.charset.Charset;
-
-import org.junit.Before;
-import org.junit.Test;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class ReadingRunnableTest {
-
- /**
- */
- @Before
- public void setUp() {}
-
- /** Test method for
- * {@link fr.bigeon.gclc.manager.ReadingRunnable#getMessage()}. */
- @Test
- public final void testGetMessage() {
- final BufferedReader reader = null;
- final ReadingRunnable runnable = new ReadingRunnable(reader);
- runnable.setRunning(false);
-
- try {
- runnable.getMessage();
- fail("reading from closed runnable");
- } catch (final IOException e) {
- // ok
- }
-
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.manager.ReadingRunnable#getWaitForDelivery(java.lang.String)}.
- *
- * @throws InterruptedException if the test failed
- * @throws IOException if the test failed */
- @Test
- public final void testGetWaitForDelivery() throws InterruptedException,
- IOException {
- try (PipedOutputStream out = new PipedOutputStream();
- InputStream piped = new PipedInputStream(out);
- BufferedReader reader = new BufferedReader(
- new InputStreamReader(piped, "UTF-8"))) {
- final ReadingRunnable runnable = new ReadingRunnable(reader);
- final Thread th0 = new Thread(runnable, "read");
- th0.start();
- final Thread th = runnable.getWaitForDelivery("msg");
-
- out.write(Charset.forName("UTF-8")
- .encode("msg" + System.lineSeparator()).array());
-
- final Thread th2 = new Thread(new Runnable() {
-
- @Override
- public void run() {
- try {
- runnable.getMessage();
- } catch (final IOException e) {
- // TODO Auto-generated catch block
- e.printStackTrace();
- }
- }
- }, "get");
- th2.start();
- th.join();
- assertFalse("Runnable should have consumed every message",
- runnable.hasMessage());
- runnable.setRunning(false);
- out.close();
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.manager.ReadingRunnable#hasMessage()}. */
- @Test
- public final void testHasMessage() {
-
- final BufferedReader reader = null;
- final ReadingRunnable runnable = new ReadingRunnable(reader);
- runnable.setRunning(false);
-
- try {
- runnable.getMessage();
- fail("reading from closed runnable");
- } catch (final IOException e) {
- // ok
- }
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.ReadingRunnableTest.java
+ * Created on: Dec 6, 2016
+ */
+package fr.bigeon.gclc.manager;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.fail;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+import java.nio.charset.Charset;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import fr.bigeon.gclc.utils.ReadingRunnable;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class ReadingRunnableTest {
+
+ /**
+ */
+ @Before
+ public void setUp() {}
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.utils.ReadingRunnable#getMessage()}. */
+ @Test
+ public final void testGetMessage() {
+ final BufferedReader reader = null;
+ final ReadingRunnable runnable = new ReadingRunnable(reader);
+ runnable.setRunning(false);
+
+ try {
+ runnable.getMessage();
+ fail("reading from closed runnable");
+ } catch (final IOException e) {
+ // ok
+ }
+
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.utils.ReadingRunnable#getWaitForDelivery(java.lang.String)}.
+ *
+ * @throws InterruptedException if the test failed
+ * @throws IOException if the test failed */
+ @Test
+ public final void testGetWaitForDelivery() throws InterruptedException,
+ IOException {
+ try (PipedOutputStream out = new PipedOutputStream();
+ InputStream piped = new PipedInputStream(out);
+ BufferedReader reader = new BufferedReader(
+ new InputStreamReader(piped, "UTF-8"))) {
+ final ReadingRunnable runnable = new ReadingRunnable(reader);
+ final Thread th0 = new Thread(runnable, "read");
+ th0.start();
+ final Thread th = runnable.getWaitForDelivery("msg");
+
+ out.write(Charset.forName("UTF-8")
+ .encode("msg" + System.lineSeparator()).array());
+
+ final Thread th2 = new Thread(new Runnable() {
+
+ @Override
+ public void run() {
+ try {
+ runnable.getMessage();
+ } catch (final IOException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
+ }
+ }
+ }, "get");
+ th2.start();
+ th.join();
+ assertFalse("Runnable should have consumed every message",
+ runnable.hasMessage());
+ runnable.setRunning(false);
+ out.close();
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.utils.ReadingRunnable#hasMessage()}. */
+ @Test
+ public final void testHasMessage() {
+
+ final BufferedReader reader = null;
+ final ReadingRunnable runnable = new ReadingRunnable(reader);
+ runnable.setRunning(false);
+
+ try {
+ runnable.getMessage();
+ fail("reading from closed runnable");
+ } catch (final IOException e) {
+ // ok
+ }
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/manager/SystemConsoleManagerTest.java b/gclc/src/test/java/fr/bigeon/gclc/manager/SystemConsoleManagerTest.java
index b8205ae..da481a4 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/manager/SystemConsoleManagerTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/manager/SystemConsoleManagerTest.java
@@ -1,146 +1,181 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.manager.SystemConsoleManagerTest.java
- * Created on: Nov 19, 2016
- */
-package fr.bigeon.gclc.manager;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.io.PrintStream;
-import java.nio.charset.Charset;
-
-import org.junit.Test;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class SystemConsoleManagerTest {
-
- /** Test method for {@link fr.bigeon.gclc.manager.ConsoleInput#isClosed()}.
- *
- * @throws IOException if the test failed
- * @throws InterruptedException if the test failed */
- @Test
- public final void testIsClosed() throws IOException, InterruptedException {
- final PipedOutputStream outStream = new PipedOutputStream();
- final InputStream in = new PipedInputStream(outStream);
- final PrintStream out = new PrintStream(outStream);
- final String test = "test";
- final StreamConsoleInput manager = new StreamConsoleInput(System.out,
- in, Charset.forName("UTF-8"));
-
- final Thread th = new Thread(new Runnable() {
-
- @SuppressWarnings("synthetic-access")
- @Override
- public void run() {
- out.println(test);
- }
- });
-
- th.start();
- assertEquals(test, manager.prompt());
- assertFalse(manager.isClosed());
- manager.close();
- assertTrue(manager.isClosed());
- try {
- manager.prompt();
- fail("prompt on closed manager");
- } catch (final IOException e) {
- // ok
- }
- th.join();
- }
-
- /** Test method for {@link fr.bigeon.gclc.manager.ConsoleInput#prompt()}.
- *
- * @throws IOException if the test failed
- * @throws InterruptedException if the test failed */
- @Test
- public final void testPrompt() throws IOException, InterruptedException {
-
- final String test = "test";
- try (PipedOutputStream outStream = new PipedOutputStream();
- InputStream in = new PipedInputStream(outStream);
- final PrintStream out = new PrintStream(outStream);
- StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
- Charset.forName("UTF-8"))) {
-
- final Thread th = new Thread(new Runnable() {
-
- @SuppressWarnings("synthetic-access")
- @Override
- public void run() {
- out.println(test);
- }
- });
-
- th.start();
- assertEquals(test, manager.prompt());
-
- th.join();
- }
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String)}.
- *
- * @throws IOException if the test failed */
- @Test
- public final void testSetPrompt() throws IOException {
- try (PipedOutputStream outStream = new PipedOutputStream();
- InputStream in = new PipedInputStream(outStream);
- final PrintStream out = new PrintStream(outStream);
- StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
- Charset.forName("UTF-8"))) {
-
- final String prt = "++";
- manager.setPrompt(prt);
- assertEquals(prt, manager.getPrompt().apply());
- }
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.manager.SystemConsoleManagerTest.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.manager;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+import java.io.PrintStream;
+import java.nio.charset.Charset;
+
+import org.junit.Test;
+
+import fr.bigeon.gclc.utils.StreamConsoleInput;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon */
+public class SystemConsoleManagerTest {
+
+ /** Test method for {@link fr.bigeon.gclc.manager.ConsoleInput#isClosed()}.
+ *
+ * @throws IOException if the test failed
+ * @throws InterruptedException if the test failed */
+ @Test
+ public final void testIsClosed() throws IOException, InterruptedException {
+ final PipedOutputStream outStream = new PipedOutputStream();
+ final InputStream in = new PipedInputStream(outStream);
+ final PrintStream out = new PrintStream(outStream);
+ final String test = "test";
+ final StreamConsoleInput manager = new StreamConsoleInput(System.out,
+ in, Charset.forName("UTF-8"));
+
+ final Thread th = new Thread(new Runnable() {
+
+ @SuppressWarnings("synthetic-access")
+ @Override
+ public void run() {
+ out.println(test);
+ }
+ });
+
+ th.start();
+ assertEquals(test, manager.prompt());
+ assertFalse(manager.isClosed());
+ manager.close();
+ assertTrue(manager.isClosed());
+ try {
+ manager.prompt();
+ fail("prompt on closed manager");
+ } catch (final IOException e) {
+ // ok
+ }
+ th.join();
+ }
+
+ /** Test method for {@link fr.bigeon.gclc.manager.ConsoleInput#prompt()}.
+ *
+ * @throws IOException if the test failed
+ * @throws InterruptedException if the test failed */
+ @Test
+ public final void testPrompt() throws IOException, InterruptedException {
+
+ final String test = "test";
+ try (PipedOutputStream outStream = new PipedOutputStream();
+ InputStream in = new PipedInputStream(outStream);
+ final PrintStream out = new PrintStream(outStream);
+ StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
+ Charset.forName("UTF-8"))) {
+
+ final Thread th = new Thread(new Runnable() {
+
+ @SuppressWarnings("synthetic-access")
+ @Override
+ public void run() {
+ out.println(test);
+ }
+ });
+
+ th.start();
+ assertEquals(test, manager.prompt());
+
+ th.join();
+ }
+ }
+
+ /** Test method for
+ * {@link fr.bigeon.gclc.manager.ConsoleInput#setPrompt(java.lang.String)}.
+ *
+ * @throws IOException if the test failed */
+ @Test
+ public final void testSetPrompt() throws IOException {
+ try (PipedOutputStream outStream = new PipedOutputStream();
+ InputStream in = new PipedInputStream(outStream);
+ final PrintStream out = new PrintStream(outStream);
+ StreamConsoleInput manager = new StreamConsoleInput(System.out, in,
+ Charset.forName("UTF-8"))) {
+
+ final String prt = "++";
+ manager.setPrompt(prt);
+ assertEquals(prt, manager.getPrompt().apply());
+ }
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterMessagesTest.java b/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterMessagesTest.java
index 32537ef..3d92a0d 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterMessagesTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterMessagesTest.java
@@ -1,67 +1,100 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.prompt.CLIPrompterMessagesTest.java
- * Created on: Nov 19, 2016
- */
-package fr.bigeon.gclc.prompt;
-
-import static org.junit.Assert.assertEquals;
-
-import org.junit.Test;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon
- *
- */
-public class CLIPrompterMessagesTest {
-
- /**
- * Test method for {@link fr.bigeon.gclc.prompt.CLIPrompterMessages#getString(java.lang.String, java.lang.Object[])}.
- */
- @Test
- public final void testGetString() {
- String key = "bad.key";
- assertEquals('!' + key + '!', CLIPrompterMessages.getString(key));
- assertEquals('!' + key + '!',
- CLIPrompterMessages.getString(key, "some arg"));
- assertEquals('!' + key + '!',
- CLIPrompterMessages.getString(key, new Object[] {}));
- }
-
-}
+/*
+ * Copyright Bigeon Emmanuel (2014)
+ *
+ * emmanuel@bigeon.fr
+ *
+ * This software is a computer program whose purpose is to
+ * provide a generic framework for console applications.
+ *
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+/**
+ * gclc:fr.bigeon.gclc.prompt.CLIPrompterMessagesTest.java
+ * Created on: Nov 19, 2016
+ */
+package fr.bigeon.gclc.prompt;
+
+/*-
+ * #%L
+ * Generic Command Ligne console
+ * %%
+ * Copyright (C) 2014 - 2018 bigeon.fr
+ * %%
+ * This software is governed by the CeCILL license under French law and
+ * abiding by the rules of distribution of free software. You can use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ *
+ * As a counterpart to the access to the source code and rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty and the software's author, the holder of the
+ * economic rights, and the successive licensors have only limited
+ * liability.
+ *
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading, using, modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean that it is complicated to manipulate, and that also
+ * therefore means that it is reserved for developers and experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and, more generally, to use and operate it in the
+ * same conditions as regards security.
+ *
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ * #L%
+ */
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+
+/**
+ *
+ * TODO
+ *
+ * @author Emmanuel Bigeon
+ *
+ */
+public class CLIPrompterMessagesTest {
+
+ /**
+ * Test method for {@link fr.bigeon.gclc.prompt.CLIPrompterMessages#getString(java.lang.String, java.lang.Object[])}.
+ */
+ @Test
+ public final void testGetString() {
+ String key = "bad.key";
+ assertEquals('!' + key + '!', CLIPrompterMessages.getString(key));
+ assertEquals('!' + key + '!',
+ CLIPrompterMessages.getString(key, "some arg"));
+ assertEquals('!' + key + '!',
+ CLIPrompterMessages.getString(key, new Object[] {}));
+ }
+
+}
diff --git a/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterTest.java b/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterTest.java
index 07645c8..8ae8d6e 100644
--- a/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterTest.java
+++ b/gclc/src/test/java/fr/bigeon/gclc/prompt/CLIPrompterTest.java
@@ -1,1212 +1,1245 @@
-/*
- * Copyright Bigeon Emmanuel (2014)
- *
- * emmanuel@bigeon.fr
- *
- * This software is a computer program whose purpose is to
- * provide a generic framework for console applications.
- *
- * This software is governed by the CeCILL license under French law and
- * abiding by the rules of distribution of free software. You can use,
- * modify and/or redistribute the software under the terms of the CeCILL
- * license as circulated by CEA, CNRS and INRIA at the following URL
- * "http://www.cecill.info".
- *
- * As a counterpart to the access to the source code and rights to copy,
- * modify and redistribute granted by the license, users are provided only
- * with a limited warranty and the software's author, the holder of the
- * economic rights, and the successive licensors have only limited
- * liability.
- *
- * In this respect, the user's attention is drawn to the risks associated
- * with loading, using, modifying and/or developing or reproducing the
- * software by the user in light of its specific status of free software,
- * that may mean that it is complicated to manipulate, and that also
- * therefore means that it is reserved for developers and experienced
- * professionals having in-depth computer knowledge. Users are therefore
- * encouraged to load and test the software's suitability as regards their
- * requirements in conditions enabling the security of their systems and/or
- * data to be ensured and, more generally, to use and operate it in the
- * same conditions as regards security.
- *
- * The fact that you are presently reading this means that you have had
- * knowledge of the CeCILL license and that you accept its terms.
- */
-/**
- * gclc:fr.bigeon.gclc.prompt.CLIPrompterTest.java
- * Created on: Nov 18, 2016
- */
-package fr.bigeon.gclc.prompt;
-
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
-
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.PipedInputStream;
-import java.io.PipedOutputStream;
-import java.io.PrintStream;
-import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.junit.After;
-import org.junit.Before;
-import org.junit.Test;
-
-import fr.bigeon.gclc.manager.PipedConsoleInput;
-import fr.bigeon.gclc.manager.PipedConsoleOutput;
-
-/**
- *
- * TODO
- *
- * @author Emmanuel Bigeon */
-public class CLIPrompterTest {
-
- /** @throws java.lang.Exception if there are exceptions */
- @Before
- public void setUp() throws Exception {
- //
- }
-
- /** @throws java.lang.Exception if there are exceptions */
- @After
- public void tearDown() throws Exception {
- //
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.prompt.CLIPrompter#promptBoolean(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, String)}. */
- @Test
- public final void testPromptBoolean() {
- try (final PipedConsoleOutput out = new PipedConsoleOutput();
- PipedOutputStream pout = new PipedOutputStream();
- PipedInputStream pis = new PipedInputStream(pout);
- BufferedReader buf = new BufferedReader(
- new InputStreamReader(pis, StandardCharsets.UTF_8));
- PipedConsoleInput in = new PipedConsoleInput(
- new PrintStream(pout))) {
- final Thread th = new Thread(new Runnable() {
-
- @Override
- public void run() {
- try {
- assertTrue(CLIPrompter.promptBoolean(out, in,
- "My message")); //$NON-NLS-1$
- assertTrue(CLIPrompter.promptBoolean(out, in,
- "My message")); //$NON-NLS-1$
- assertFalse(CLIPrompter.promptBoolean(out, in,
- "My message")); //$NON-NLS-1$
- assertFalse(CLIPrompter.promptBoolean(out, in,
- "My message")); //$NON-NLS-1$
- } catch (final IOException e) {
- fail("Unexpected io excpetion"); //$NON-NLS-1$
- e.printStackTrace();
- }
- }
- });
- th.start();
- assertTrue(buf.readLine().startsWith("My message")); //$NON-NLS-1$
- in.type(""); //$NON-NLS-1$
- out.readNextLine();
- assertTrue(buf.readLine().startsWith("My message")); //$NON-NLS-1$
- in.type("Y"); //$NON-NLS-1$
- assertTrue(buf.readLine().startsWith("My message")); //$NON-NLS-1$
- in.type("yes"); //$NON-NLS-1$
- assertTrue(buf.readLine().startsWith("My message")); //$NON-NLS-1$
- in.type("N"); //$NON-NLS-1$
- assertTrue(buf.readLine().startsWith("My message")); //$NON-NLS-1$
- in.type("nO"); //$NON-NLS-1$
- th.join();
- } catch (IOException | InterruptedException e) {
- fail("Unexpected excpetion"); //$NON-NLS-1$
- e.printStackTrace();
- }
-
- }
-
- /** Test method for
- * {@link fr.bigeon.gclc.prompt.CLIPrompter#promptChoice(fr.bigeon.gclc.manager.ConsoleOutput, fr.bigeon.gclc.manager.ConsoleInput, List, List, String, String)}. */
- @Test
- public final void testPromptChoiceConsoleManagerListOfStringListOfUStringString() {
- try (final PipedConsoleOutput out = new PipedConsoleOutput();
- PipedOutputStream pout = new PipedOutputStream();
- PipedInputStream pis = new PipedInputStream(pout);
- BufferedReader buf = new BufferedReader(
- new InputStreamReader(pis, StandardCharsets.UTF_8));
- PipedConsoleInput in = new PipedConsoleInput(
- new PrintStream(pout))) {
- final Listexit command. Then it will print "see you latter" and exit the
- * start method.
- *
- * @author Emmanuel BIGEON */
-public final class ConsoleApplication implements ICommandProvider {
-
- /** The class logger. */
- private static final Logger LOGGER = Logger
- .getLogger(ConsoleApplication.class.getName());
- /** The welcome message. */
- public final String header;
- /** The good bye message. */
- public final String footer;
- /** The standard output for the application. */
- private final ConsoleOutput out;
- /** The standard input for the application. */
- private final ConsoleInput in;
- /** The container of commands. */
- public final SubedCommand root;
- /** The state of this application. */
- private boolean running;
- /** The listeners. */
- private final List
+ * {@link ConsoleOutput} out = new {@link fr.bigeon.gclc.utils.StreamConsoleOutput StreamConsoleOutput}();
+ * {@link ConsoleInput} in = new {@link fr.bigeon.gclc.utils.StreamConsoleInput StreamConsoleInput}();
+ * {@link ConsoleApplication} app = new {@link ConsoleApplication}(out, in, "welcome", "see you latter")};
+ * app.{@link ConsoleApplication#add(ICommand) add}("my_command", new {@link ICommand MyCommand()});
+ * app.{@link ConsoleApplication#start() start()};
+ *
+ * exit command. Then it will print "see you latter" and exit the
+ * start method.
+ *
+ * @author Emmanuel BIGEON */
+public final class ConsoleApplication implements ICommandProvider {
+
+ /** The class logger. */
+ private static final Logger LOGGER = Logger
+ .getLogger(ConsoleApplication.class.getName());
+ /** The welcome message. */
+ public final String header;
+ /** The good bye message. */
+ public final String footer;
+ /** The standard output for the application. */
+ private final ConsoleOutput out;
+ /** The standard input for the application. */
+ private final ConsoleInput in;
+ /** The container of commands. */
+ public final SubedCommand root;
+ /** The state of this application. */
+ private boolean running;
+ /** The listeners. */
+ private final List
- *
- *
- * [Command name]
- * [brief message]
- *
- * Usage:
- * [Usage pattern]
- *
- * [Usage details]
- *
- *
- * @see fr.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
- @Override
- public final void help(final ConsoleOutput manager,
- final String... args) throws IOException {
- manager.println(getCommandName());
- manager.println(brief());
- manager.println();
- manager.println("Usage:"); //$NON-NLS-1$
- manager.println(usagePattern());
- manager.println();
- final String details = usageDetail();
- if (details != null && !details.isEmpty()) {
- manager.print(details);
- if (!(details.endsWith(EOL_LINUX) ||
- details.endsWith(System.lineSeparator()))) {
- manager.println();
- }
- }
- }
-
- /** This method return the detail of the help.
- *
+ *
+ *
+ * [Command name]
+ * [brief message]
+ *
+ * Usage:
+ * [Usage pattern]
+ *
+ * [Usage details]
+ *
+ *
+ * @see fr.bigeon.gclc.command.ICommand#help(ConsoleOutput, String...) */
+ @Override
+ public final void help(final ConsoleOutput manager,
+ final String... args) throws IOException {
+ manager.println(getCommandName());
+ manager.println(brief());
+ manager.println();
+ manager.println("Usage:"); //$NON-NLS-1$
+ manager.println(usagePattern());
+ manager.println();
+ final String details = usageDetail();
+ if (details != null && !details.isEmpty()) {
+ manager.print(details);
+ if (!(details.endsWith(EOL_LINUX) ||
+ details.endsWith(System.lineSeparator()))) {
+ manager.println();
+ }
+ }
+ }
+
+ /** This method return the detail of the help.
+ *