summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
diff options
context:
space:
mode:
authorbculkin2442 <bjculkin@mix.wvu.edu>2016-05-10 16:02:45 -0400
committerbculkin2442 <bjculkin@mix.wvu.edu>2016-05-10 16:02:45 -0400
commit61fd71f69e080790da722e0e03b71ecd7c2538a2 (patch)
treee5c1150b27b84d550f807e44ac82688216451f00 /BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
parent87ae1dfc8d8cb7b51d7bda4750ce841bbe691cfc (diff)
General update
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java13
1 files changed, 12 insertions, 1 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java b/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
index f2fb146..8742b5d 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
@@ -7,6 +7,7 @@ package bjc.utils.cli;
*
*/
public class GenericHelp implements ICommandHelp {
+ // The strings for this help topic
private String summary;
private String description;
@@ -16,15 +17,25 @@ public class GenericHelp implements ICommandHelp {
* @param summary
* The summary of this help topic
* @param description
- * The description of this help topic
+ * The description of this help topic, or null if this help
+ * topic doesn't have a more detailed description
*/
public GenericHelp(String summary, String description) {
+ if (summary == null) {
+ throw new NullPointerException(
+ "Help summary must be non-null");
+ }
+
this.summary = summary;
this.description = description;
}
@Override
public String getDescription() {
+ if (description == null) {
+ return summary;
+ }
+
return description;
}