emmanuel/gclc-core
emmanuel/gclc-core
1
0
Fork 0
Code Issues 2 Pull Requests Projects 1 Releases Wiki Activity

[chore] Move InterruptedIOException full name into documentation.

Browse Source 
This avoids unnecessarily importing it.

Signed-off-by: Emmanuel Bigeon <emmanuel@bigeon.fr>
This commit is contained in:
Emmanuel Bigeon 2021-11-07 11:59:32 +01:00
parent 7b7d0e6747
commit b38980eeb5
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
gclc/src/main/java/net/bigeon/gclc/manager/ConsoleInput.java
View File

@ -72,7 +72,6 @@ package net.bigeon.gclc.manager;
* #L% * #L%
*/ */
import java.io.IOException; import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.function.Supplier; import java.util.function.Supplier;
/** A console application input. /** A console application input.
@ -94,7 +93,7 @@ public interface ConsoleInput extends AutoCloseable {
/** Indicate to the input that is should interrompt the prompting, if possible. /** Indicate to the input that is should interrompt the prompting, if possible.
* <p> * <p>
* The pending {@link #prompt()} or {@link #prompt(String)} operations should * The pending {@link #prompt()} or {@link #prompt(String)} operations should
* return immediately by throwing an InterruptedIOException. */ * return immediately by throwing an java.io.InterruptedIOException. */
void interruptPrompt(); void interruptPrompt();
/** Test if the input is closed. /** Test if the input is closed.
@ -109,7 +108,7 @@ public interface ConsoleInput extends AutoCloseable {
* *
* @return the user inputed string * @return the user inputed string
* @throws IOException if the manager is closed or could not read the prompt * @throws IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */ * @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt() throws IOException; String prompt() throws IOException;
/** Prompt the user, with an allotated time to answer. /** Prompt the user, with an allotated time to answer.
@ -117,7 +116,7 @@ public interface ConsoleInput extends AutoCloseable {
* @param timeout the time to wait in milliseconds * @param timeout the time to wait in milliseconds
* @return the user inputed string, null if the timeout was reached * @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 IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */ * @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt(long timeout) throws IOException; String prompt(long timeout) throws IOException;
/** Prompt the user, with a hint on what is prompted. /** Prompt the user, with a hint on what is prompted.
@ -125,7 +124,7 @@ public interface ConsoleInput extends AutoCloseable {
* @param message the message to prompt the user * @param message the message to prompt the user
* @return the user inputed string * @return the user inputed string
* @throws IOException if the manager is closed or could not read the prompt * @throws IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */ * @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt(String message) throws IOException; String prompt(String message) throws IOException;
/** Prompt the user, with a hint on what is prompted and an allotated time to /** Prompt the user, with a hint on what is prompted and an allotated time to
@ -135,7 +134,7 @@ public interface ConsoleInput extends AutoCloseable {
* @param message the message to prompt the user * @param message the message to prompt the user
* @return the user inputed string, null if the timeout was reached * @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 IOException if the manager is closed or could not read the prompt
* @throws InterruptedIOException if the prompt was interrupted */ * @throws java.io.InterruptedIOException if the prompt was interrupted */
String prompt(String message, long timeout) throws IOException; String prompt(String message, long timeout) throws IOException;
/** Set a prompting prefix. /** Set a prompting prefix.