Change to Supplier. Fix tests

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
This commit is contained in:
2018-11-25 09:16:38 -05:00
parent ddd818d93b
commit ad79e3ccb6
11 changed files with 280 additions and 439 deletions

View File

@@ -73,8 +73,7 @@ package net.bigeon.gclc.manager;
*/
import java.io.IOException;
import java.io.InterruptedIOException;
import net.bigeon.gclc.tools.StringProvider;
import java.util.function.Supplier;
/** A console application input.
*
@@ -90,7 +89,7 @@ public interface ConsoleInput extends AutoCloseable {
/** Get the prompt string.
*
* @return the prompt prefix */
StringProvider getPrompt();
Supplier<String> getPrompt();
/** Indicate to the input that is should interrompt the prompting, if possible.
* <p>
@@ -148,5 +147,5 @@ public interface ConsoleInput extends AutoCloseable {
/** Set the prompting string.
*
* @param string the prompt string */
void setPrompt(StringProvider string);
void setPrompt(Supplier<String> string);
}

View File

@@ -34,6 +34,9 @@
*/
package net.bigeon.gclc.tools;
import java.util.Objects;
import java.util.function.Supplier;
/*-
* #%L
* Generic Command Ligne console
@@ -68,10 +71,10 @@ package net.bigeon.gclc.tools;
* #L%
*/
/** A {@link StringProvider} that hold a constant string.
/** A supplier of string that hold a constant string.
*
* @author Emmanuel Bigeon */
public class ConstantString implements StringProvider {
public class ConstantString implements Supplier<String> {
private final String string;
/** Create a provider for a string.
@@ -81,10 +84,8 @@ public class ConstantString implements StringProvider {
this.string = string;
}
/* (non-Javadoc)
* @see net.bigeon.gclc.tools.StringProvider#apply() */
@Override
public String apply() {
public String get() {
return string;
}
@@ -92,10 +93,7 @@ public class ConstantString implements StringProvider {
* @see java.lang.Object#hashCode() */
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((string == null) ? 0 : string.hashCode());
return result;
return Objects.hash(string);
}
/* (non-Javadoc)
@@ -112,13 +110,6 @@ public class ConstantString implements StringProvider {
return false;
}
final ConstantString other = (ConstantString) obj;
if (string == null) {
if (other.string != null) {
return false;
}
} else if (!string.equals(other.string)) {
return false;
}
return true;
return Objects.equals(string, other.string);
}
}

View File

@@ -1,83 +0,0 @@
/*
* 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 net.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 string providing object.
* <p>
* 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 */
public interface StringProvider {
/** Provide a string.
*
* @return the string */
String apply();
}

View File

@@ -38,6 +38,8 @@
*/
package net.bigeon.gclc.utils;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
/*-
@@ -75,7 +77,6 @@ import net.bigeon.gclc.manager.ConsoleInput;
*/
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** A console input that return empty to all prompting.
*
@@ -101,8 +102,8 @@ public final class EmptyInput implements ConsoleInput {
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
return CONSTANT_STRING; //$NON-NLS-1$
public Supplier<String> getPrompt() {
return CONSTANT_STRING;
}
/* (non-Javadoc)
@@ -155,7 +156,7 @@ public final class EmptyInput implements ConsoleInput {
}
@Override
public void setPrompt(StringProvider string) {
public void setPrompt(final Supplier<String> string) {
//
}
}

View File

@@ -76,9 +76,9 @@ import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.StringProvider;
/** This console input allows to enter commands and retrieve the output as an
* input.
@@ -120,7 +120,7 @@ public final class PipedConsoleInput implements ConsoleInput {
}
@Override
public StringProvider getPrompt() {
public Supplier<String> getPrompt() {
return innerManager.getPrompt();
}
@@ -174,7 +174,7 @@ public final class PipedConsoleInput implements ConsoleInput {
}
@Override
public void setPrompt(StringProvider string) {
public void setPrompt(final Supplier<String> string) {
innerManager.setPrompt(string);
}

View File

@@ -77,10 +77,10 @@ import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintStream;
import java.nio.charset.Charset;
import java.util.function.Supplier;
import net.bigeon.gclc.manager.ConsoleInput;
import net.bigeon.gclc.tools.ConstantString;
import net.bigeon.gclc.tools.StringProvider;
/** A console using the input stream and print stream.
* <p>
@@ -90,10 +90,10 @@ import net.bigeon.gclc.tools.StringProvider;
public final class StreamConsoleInput implements ConsoleInput {
/** The default prompt. */
public static final StringProvider DEFAULT_PROMPT = new ConstantString("> "); //$NON-NLS-1$
public static final Supplier<String> DEFAULT_PROMPT = new ConstantString("> "); //$NON-NLS-1$
/** The command prompt. It can be changed. */
private StringProvider prompt = DEFAULT_PROMPT;
private Supplier<String> prompt = DEFAULT_PROMPT;
/** The print stream. */
private final PrintStream out;
@@ -152,7 +152,7 @@ public final class StreamConsoleInput implements ConsoleInput {
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleInput#getPrompt() */
@Override
public StringProvider getPrompt() {
public Supplier<String> getPrompt() {
return prompt;
}
@@ -175,14 +175,14 @@ public final class StreamConsoleInput implements ConsoleInput {
* @see net.bigeon.gclc.ConsoleManager#prompt() */
@Override
public String prompt() throws IOException {
return prompt(prompt.apply());
return prompt(prompt.get());
}
/* (non-Javadoc)
* @see net.bigeon.gclc.manager.ConsoleManager#prompt(long) */
@Override
public String prompt(final long timeout) throws IOException {
return prompt(prompt.apply(), timeout);
return prompt(prompt.get(), timeout);
}
/* (non-Javadoc)
@@ -217,7 +217,7 @@ public final class StreamConsoleInput implements ConsoleInput {
}
@Override
public void setPrompt(StringProvider string) {
public void setPrompt(final Supplier<String> string) {
prompt = string;
}
}