summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/cli/Command.java
blob: 59692980601ea0a06b86e1990d7d7ec4efab77db (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
package bjc.utils.cli;

/**
 * Represents a command that can be invoked from a {@link CommandMode}
 *
 * @author ben
 */
public interface Command {
	/**
	 * Create a command that serves as an alias to this one
	 *
	 * @return 
	 * 	A command that serves as an alias to this one
	 */
	Command aliased();

	/**
	 * Get the handler that executes this command
	 *
	 * @return
	 * 	The handler that executes this command
	 */
	CommandHandler getHandler();

	/**
	 * Get the help entry for this command
	 *
	 * @return
	 * 	The help entry for this command
	 */
	CommandHelp getHelp();

	/**
	 * Check if this command is an alias of another command
	 *
	 * @return
	 * 	Whether or not this command is an alias of another
	 */
	default boolean isAlias() {
		return false;
	}
}