org.arl.fjage.shell

Class ConsoleShell

java.lang.Object

org.arl.fjage.shell.ConsoleShell

All Implemented Interfaces:

ConnectionListener, Shell

public class ConsoleShell
extends java.lang.Object
implements Shell, ConnectionListener

Shell input/output driver for console devices with line editing and color support.

Field Summary

Fields inherited from interface org.arl.fjage.shell.Shell

ABORT

Constructor Summary

Constructors

Constructor and Description
ConsoleShell() Create a console shell attached to the system terminal.
ConsoleShell(Connector connector) Create a console shell attached to a specified connector.
ConsoleShell(Connector connector, java.nio.file.Path historyFile) Create a console shell attached to a specified connector.
ConsoleShell(java.io.InputStream in, java.io.OutputStream out) Create a console shell attached to a specified input and output stream.
ConsoleShell(java.io.InputStream in, java.io.OutputStream out, java.nio.file.Path historyFile) Create a console shell attached to a specified input and output stream.
ConsoleShell(java.nio.file.Path historyFile) Create a console shell attached to the system terminal.

Method Summary

Modifier and Type	Method and Description
void	connected(Connector connector)
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsoleShell

public ConsoleShell()

Create a console shell attached to the system terminal.

ConsoleShell

public ConsoleShell(java.io.InputStream in,
                    java.io.OutputStream out)

Create a console shell attached to a specified input and output stream.

Parameters:

in - input stream.

out - output stream.

ConsoleShell

public ConsoleShell(Connector connector)

Create a console shell attached to a specified connector.

Parameters:

connector - input/output streams.

ConsoleShell

public ConsoleShell(java.nio.file.Path historyFile)

Create a console shell attached to the system terminal.

Parameters:

historyFile - file to store command history.

ConsoleShell

public ConsoleShell(java.io.InputStream in,
                    java.io.OutputStream out,
                    java.nio.file.Path historyFile)

Create a console shell attached to a specified input and output stream.

Parameters:

in - input stream.

out - output stream.

historyFile - file to store command history.

ConsoleShell

public ConsoleShell(Connector connector,
                    java.nio.file.Path historyFile)

Create a console shell attached to a specified connector.

Parameters:

connector - input/output streams.

historyFile - file to store command history.

Method Detail

connected

public void connected(Connector connector)

Specified by:

connected in interface ConnectionListener

init

public void init(ScriptEngine engine)

Description copied from interface: Shell

Initialize the shell.

Specified by:

init in interface Shell

Parameters:

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

prompt

public void prompt(java.lang.Object obj)

Description copied from interface: Shell

Prompt user for input.

Specified by:

prompt in interface Shell

input

public void input(java.lang.Object obj)

Description copied from interface: Shell

Display input line.

Specified by:

input in interface Shell

println

public void println(java.lang.Object obj)

Description copied from interface: Shell

Display script output.

Specified by:

println in interface Shell

notify

public void notify(java.lang.Object obj)

Description copied from interface: Shell

Display unsolicited notification.

Specified by:

notify in interface Shell

error

public void error(java.lang.Object obj)

Description copied from interface: Shell

Display error.

Specified by:

error in interface Shell

readLine

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

Description copied from interface: Shell

Read a line from the shell.

Specified by:

readLine in interface 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

public boolean isDumb()

Description copied from interface: Shell

Check if terminal supports ANSI control sequences.

Specified by:

isDumb in interface Shell

Returns:

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

shutdown

public void shutdown()

Description copied from interface: Shell

Shutdown the shell.

Specified by:

shutdown in interface Shell

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object