summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/GenericCommand.java
blob: bb624cd33cb6418fde790aea79e792937ba31f36 (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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package bjc.utils.cli;

/**
 * Generic command implementation.
 *
 * @author ben
 */
public class GenericCommand implements Command {
	/* The behavior for invoking the command. */
	private final CommandHandler handler;

	/* The help for the command. */
	private CommandHelp help;

	/**
	 * Create a new generic command.
	 *
	 * @param handler
	 *        The handler to use for the command.
	 *
	 * @param description
	 *        The description of the command. May be null, in which case a
	 *        default is provided.
	 *
	 * @param help
	 *        The detailed help message for the command. May be null, in
	 *        which case the description is repeated for the detailed help.
	 */
	public GenericCommand(final CommandHandler handler, final String description, final String help) {
		if(handler == null) throw new NullPointerException("Command handler must not be null");

		this.handler = handler;

		if(description == null) {
			this.help = new NullHelp();
		} else {
			this.help = new GenericHelp(description, help);
		}
	}

	@Override
	public Command aliased() {
		return new DelegatingCommand(this);
	}

	@Override
	public CommandHandler getHandler() {
		return handler;
	}

	@Override
	public CommandHelp getHelp() {
		return help;
	}

	@Override
	public boolean isAlias() {
		return false;
	}

	/*
	 * (non-Javadoc)
	 *
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		return String.format("GenericCommand [help=%s]", help);
	}
}