From 98cdf435d4974f4cca8f7b4eb4026da2c88cbc4c Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Sun, 26 Mar 2017 11:30:43 -0400 Subject: Update --- .../src/main/java/bjc/utils/cli/CommandHelp.java | 27 ++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java (limited to 'BJC-Utils2/src/main/java/bjc/utils/cli/CommandHelp.java') 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 + * "\t" where anything in angle brackets + * should be filled in. + * + * @return The summary line line for a command + */ + String getSummary(); +} -- cgit v1.2.3