summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/cli/CLICommander.java
blob: e1a57c2fd8bc5714782054c6052a51e61484beff (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
package bjc.utils.cli;

import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.util.Arrays;
import java.util.Scanner;

/**
 * Runs a CLI interface from the provided set of streams
 * 
 * @author ben
 *
 */
public class CLICommander {
	private InputStream		input;
	private OutputStream	output;
	private OutputStream	error;

	private ICommandMode	initialMode;

	/**
	 * Create a new CLI interface powered by streams
	 * 
	 * @param input
	 *            The stream to get user input from
	 * @param output
	 *            The stream to send user output to
	 * @param error
	 *            The stream to send error messages to
	 */
	public CLICommander(InputStream input, OutputStream output,
			OutputStream error) {
		if (input == null) {
			throw new NullPointerException(
					"Input stream must not be null");
		} else if (output == null) {
			throw new NullPointerException(
					"Output stream must not be null");
		} else if (error == null) {
			throw new NullPointerException(
					"Error stream must not be null");
		}

		this.input = input;
		this.output = output;
		this.error = error;
	}

	/**
	 * Run a set of commands through this commander
	 */
	public void runCommands() {
		PrintStream normalOutput = new PrintStream(output);
		PrintStream errorOutput = new PrintStream(error);

		@SuppressWarnings("resource")
		// We might use this stream multiple times. Don't close it
		Scanner inputSource = new Scanner(input);

		ICommandMode currentMode = initialMode;

		while (currentMode != null) {
			if (currentMode.useCustomPrompt()) {
				normalOutput.print(currentMode.getCustomPrompt());
			} else {
				normalOutput.print(currentMode.getName() + ">> ");
			}

			String currentLine = inputSource.nextLine();

			if (currentMode.canHandleCommand(currentLine)) {
				String[] commandTokens = currentLine.split(" ");

				String[] commandArgs;

				if (commandTokens.length > 1) {
					commandArgs = Arrays.copyOfRange(commandTokens, 1,
							commandTokens.length);
				} else {
					commandArgs = null;
				}

				currentMode = currentMode.processCommand(commandTokens[0],
						commandArgs);
			} else {
				errorOutput.print(
						"Error: Unrecognized command " + currentLine);
			}
		}

		normalOutput.print("Exiting now.");
	}

	/**
	 * Set the initial command mode to use
	 * 
	 * @param initialMode
	 *            The initial command mode to use
	 */
	public void setInitialCommandMode(ICommandMode initialMode) {
		if (initialMode == null) {
			throw new NullPointerException(
					"Initial mode must be non-zero");
		}

		this.initialMode = initialMode;
	}
}