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

/**
 * Represents a command that can be invoked from a {@link ICommandMode}
 * 
 * @author ben
 *
 */
public interface ICommand {
	/**
	 * Get the handler that executes this command
	 * 
	 * @return The handler that executes this command
	 */
	public ICommandHandler getHandler();

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

	/**
	 * Create a command that serves as an alias to this one
	 * 
	 * @return A command that serves as an alias to this one
	 */
	public ICommand createAlias();

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