summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
diff options
context:
space:
mode:
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.java63
1 files changed, 0 insertions, 63 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
deleted file mode 100644
index 38adf57..0000000
--- a/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
+++ /dev/null
@@ -1,63 +0,0 @@
-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();
- }
-}