From c82e3b3b2de0633317ec8fc85925e91422820597 Mon Sep 17 00:00:00 2001
From: "Benjamin J. Culkin" <bjculkin@mix.wvu.edu>
Date: Sun, 8 Oct 2017 22:39:59 -0300
Subject: Start splitting into maven modules

---
 base/src/main/java/bjc/utils/cli/CommandHelp.java | 31 +++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 base/src/main/java/bjc/utils/cli/CommandHelp.java

(limited to 'base/src/main/java/bjc/utils/cli/CommandHelp.java')

diff --git a/base/src/main/java/bjc/utils/cli/CommandHelp.java b/base/src/main/java/bjc/utils/cli/CommandHelp.java
new file mode 100644
index 0000000..86567a0
--- /dev/null
+++ b/base/src/main/java/bjc/utils/cli/CommandHelp.java
@@ -0,0 +1,31 @@
+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
+	 * 
+	 * <pre>
+	 * "&lt;command-name>\t&lt;command-summary>"
+	 * </pre>
+	 * 
+	 * where anything in angle brackets should be filled in.
+	 *
+	 * @return The summary line line for a command
+	 */
+	String getSummary();
+}
-- 
cgit v1.2.3