summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/CommandMode.java
diff options
context:
space:
mode:
authorbjculkin <bjculkin@mix.wvu.edu>2018-02-12 22:45:04 -0500
committerbjculkin <bjculkin@mix.wvu.edu>2018-02-12 22:45:04 -0500
commitdf94066e3af02ff02d5ab4d033a3d603f743234c (patch)
tree168a1edaf58d386c175ffb601e9d4da8e13d31e2 /base/src/main/java/bjc/utils/cli/CommandMode.java
parentae51c587c53f7ca311e556e3cbd0c5566d6c2843 (diff)
Formatting pass
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/CommandMode.java')
-rw-r--r--base/src/main/java/bjc/utils/cli/CommandMode.java29
1 files changed, 12 insertions, 17 deletions
diff --git a/base/src/main/java/bjc/utils/cli/CommandMode.java b/base/src/main/java/bjc/utils/cli/CommandMode.java
index 0415e27..b33077b 100644
--- a/base/src/main/java/bjc/utils/cli/CommandMode.java
+++ b/base/src/main/java/bjc/utils/cli/CommandMode.java
@@ -11,11 +11,10 @@ public interface CommandMode extends Comparable<CommandMode> {
* Check to see if this mode can handle the specified command.
*
* @param command
- * The command to check.
+ * The command to check.
*
- * @return
- * Whether or not this mode can handle the command. It is
- * assumed not by default.
+ * @return Whether or not this mode can handle the command. It is
+ * assumed not by default.
*/
default boolean canHandle(final String command) {
return false;
@@ -24,11 +23,10 @@ public interface CommandMode extends Comparable<CommandMode> {
/**
* Get the custom prompt for this mode.
*
- * @return
- * The custom prompt for this mode.
+ * @return The custom prompt for this mode.
*
* @throws UnsupportedOperationException
- * If this mode doesn't support a custom prompt.
+ * If this mode doesn't support a custom prompt.
*/
default String getCustomPrompt() {
throw new UnsupportedOperationException("This mode doesn't support a custom prompt");
@@ -37,9 +35,8 @@ public interface CommandMode extends Comparable<CommandMode> {
/**
* Get the name of this command mode.
*
- * @return
- * The name of this command mode, or a default string if one isn't
- * specified.
+ * @return The name of this command mode, or a default string if one
+ * isn't specified.
*/
public default String getName() {
return "(anonymous)";
@@ -48,8 +45,7 @@ public interface CommandMode extends Comparable<CommandMode> {
/**
* Check if this mode uses a custom prompt.
*
- * @return
- * Whether or not this mode uses a custom prompt.
+ * @return Whether or not this mode uses a custom prompt.
*/
default boolean isCustomPromptEnabled() {
return false;
@@ -59,14 +55,13 @@ public interface CommandMode extends Comparable<CommandMode> {
* Process a command in this mode..
*
* @param command
- * The command to process.
+ * The command to process.
*
* @param args
- * A list of arguments to the command.
+ * A list of arguments to the command.
*
- * @return
- * The command mode to use for the next command. Defaults to doing
- * nothing, and staying in the current mode.
+ * @return The command mode to use for the next command. Defaults to
+ * doing nothing, and staying in the current mode.
*/
default CommandMode process(final String command, final String[] args) {
return this;