summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/GenericHelp.java
blob: f2fb14674c36bb1409be4d533047edcb269ee238 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package bjc.utils.cli;

/**
 * Generic implementation of a help topic
 * 
 * @author ben
 *
 */
public class GenericHelp implements ICommandHelp {
	private String	summary;
	private String	description;

	/**
	 * Create a new help topic
	 * 
	 * @param summary
	 *            The summary of this help topic
	 * @param description
	 *            The description of this help topic
	 */
	public GenericHelp(String summary, String description) {
		this.summary = summary;
		this.description = description;
	}

	@Override
	public String getDescription() {
		return description;
	}

	@Override
	public String getSummary() {
		return summary;
	}

}