summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java27
1 files changed, 27 insertions, 0 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java b/BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java
new file mode 100644
index 0000000..327fb75
--- /dev/null
+++ b/BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java
@@ -0,0 +1,27 @@
+package bjc.utils.cli;
+
+/**
+ * Interface for the help entry for a command
+ *
+ * @author ben
+ *
+ */
+public interface CommandHelp {
+ /**
+ * Get the description of a command.
+ *
+ * @return The description of a command
+ */
+ String getDescription();
+
+ /**
+ * Get the summary line for a command.
+ *
+ * A summary line should consist of a string of the following format
+ * "<command-name>\t<command-summary>" where anything in angle brackets
+ * should be filled in.
+ *
+ * @return The summary line line for a command
+ */
+ String getSummary();
+}