From 275a627719fc2231b16caea41130ff09f0f2b6a1 Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Fri, 8 Apr 2016 13:28:09 -0400 Subject: Switch functional data to use interfaces --- .../src/main/java/bjc/utils/cli/ICommandHelp.java | 26 ++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java (limited to 'BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java') 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(); +} -- cgit v1.2.3