org.arl.fjage.shell

Interface Shell

All Known Implementing Classes:

ConsoleShell, DumbShell

public interface Shell

Any shell input/output driver should implement this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABORT Abort string returned when user presses ^C.

Method Summary

Modifier and Type	Method and Description
void	error(java.lang.Object obj) Display error.
void	init(ScriptEngine engine) Initialize the shell.
void	input(java.lang.Object obj) Display input line.
boolean	isDumb() Check if terminal supports ANSI control sequences.
void	notify(java.lang.Object obj) Display unsolicited notification.
void	println(java.lang.Object obj) Display script output.
void	prompt(java.lang.Object obj) Prompt user for input.
java.lang.String	readLine(java.lang.String prompt1, java.lang.String prompt2, java.lang.String line) Read a line from the shell.
void	shutdown() Shutdown the shell.

Field Detail

ABORT

static final java.lang.String ABORT

Abort string returned when user presses ^C.

See Also:

Constant Field Values

Method Detail

init

void init(ScriptEngine engine)

Initialize the shell.

Parameters:

engine - script engine to use for sentence completion check, or null to disable.

prompt

void prompt(java.lang.Object obj)

Prompt user for input.

input

void input(java.lang.Object obj)

Display input line.

println

void println(java.lang.Object obj)

Display script output.

notify

void notify(java.lang.Object obj)

Display unsolicited notification.

error

void error(java.lang.Object obj)

Display error.

readLine

java.lang.String readLine(java.lang.String prompt1,
                          java.lang.String prompt2,
                          java.lang.String line)

Read a line from the shell.

Parameters:

prompt1 - prompt to display on first line, null if none.

prompt2 - prompt to display on continuation line, null if none.

line - input text to edit, null if blank.

Returns:

input string, null on EOF, or ABORT on ^C.

isDumb

boolean isDumb()

Check if terminal supports ANSI control sequences.

Returns:

true if it does not support control sequences, false if it supports.

shutdown

void shutdown()

Shutdown the shell.