summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/ICommandHelp.java
blob: d4753359cc76f1e69945bac3256e55430844ef9a (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
package bjc.utils.cli;

/**
 * Interface for the help entry for a command
 * 
 * @author ben
 *
 */
public interface ICommandHelp {
	/**
	 * Get the description of a command
	 * 
	 * @return The description of a command
	 */
	public String getDescription();

	/**
	 * Get the summary line for a command
	 * 
	 * Used for 'help commands' which gives the user a brief idea what all
	 * the commands do
	 * 
	 * @return The summary line line for a command
	 */
	public String getSummary();
}