Switch functional data to use interfaces

1 files changed, 26 insertions, 0 deletions

diff --git a/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java b/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java
new file mode 100644
index 0000000..ad03dac
--- /dev/null
+++ b/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java
@@ -0,0 +1,26 @@
+package bjc.utils.cli;
+
+/**
+ * Interface for the help entry for a command
+ * 
+ * @author ben
+ *
+ */
+public interface ICommandHelp {
+	/**
+	 * Get the summary line for a command
+	 * 
+	 * Used for 'help commands' which gives the user a brief idea what all
+	 * the commands do
+	 * 
+	 * @return The summary line line for a command
+	 */
+	public String getSummary();
+
+	/**
+	 * Get the description of a command
+	 * 
+	 * @return The description of a command
+	 */
+	public String getDescription();
+}