summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/GenericHelp.java
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-08 22:39:59 -0300
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-08 22:39:59 -0300
commitc82e3b3b2de0633317ec8fc85925e91422820597 (patch)
tree96567416ce23c5ce85601f9cedc3a94bb1c55cba /base/src/main/java/bjc/utils/cli/GenericHelp.java
parentb3ac1c8690c3e14c879913e5dcc03a5f5e14876e (diff)
Start splitting into maven modules
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/GenericHelp.java')
-rw-r--r--base/src/main/java/bjc/utils/cli/GenericHelp.java63
1 files changed, 63 insertions, 0 deletions
diff --git a/base/src/main/java/bjc/utils/cli/GenericHelp.java b/base/src/main/java/bjc/utils/cli/GenericHelp.java
new file mode 100644
index 0000000..38adf57
--- /dev/null
+++ b/base/src/main/java/bjc/utils/cli/GenericHelp.java
@@ -0,0 +1,63 @@
+package bjc.utils.cli;
+
+/**
+ * Generic implementation of a help topic
+ *
+ * @author ben
+ *
+ */
+public class GenericHelp implements CommandHelp {
+ // The strings for this help topic
+ private final String summary;
+ private final String description;
+
+ /**
+ * Create a new help topic
+ *
+ * @param summary
+ * The summary of this help topic
+ * @param description
+ * The description of this help topic, or null if this
+ * help topic doesn't have a more detailed description
+ */
+ public GenericHelp(final String summary, final 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;
+ }
+
+ @Override
+ public String getSummary() {
+ return summary;
+ }
+
+ @Override
+ public String toString() {
+ final StringBuilder builder = new StringBuilder();
+
+ builder.append("GenericHelp [");
+
+ if (summary != null) {
+ builder.append("summary=");
+ builder.append(summary);
+ }
+
+ if (description != null) {
+ builder.append(", ");
+ builder.append("description=");
+ builder.append(description);
+ }
+
+ builder.append("]");
+
+ return builder.toString();
+ }
+}