org.overlord.sramp.shell

Interface ShellCommandReader

All Known Implementing Classes:

AbstractShellCommandReader, ConsoleShellCommandReader, FileShellCommandReader, InteractiveShellCommandReader, StdInShellCommandReader

public interface ShellCommandReader

Interface used to read commands from the user (or some other source, like an input file).

Author:

eric.wittmann@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Called by the shell when exiting.
boolean	isBatch()
void	open() Called to open the shell command reader.
String	promptForInput(String prompt) Prompts the user for some input.
String	promptForPassword(String prompt) Prompts the user for a password.
ShellCommand	read() Reads the next command from the input source.

Method Detail

open

void open()
          throws IOException

Called to open the shell command reader.

Throws:

IOException

read

ShellCommand read()
                  throws Exception

Reads the next command from the input source.

Throws:

Exception

close

void close()
           throws IOException

Called by the shell when exiting.

Throws:

IOException

isBatch

boolean isBatch()

Returns:

true if this is a batch command reader

promptForInput

String promptForInput(String prompt)

Prompts the user for some input. Returns the text entered by the user.

Parameters:

prompt -

promptForPassword

String promptForPassword(String prompt)

Prompts the user for a password. Returns the text entered by the user.

Parameters:

prompt -