Package org.dellroad.jct.core.simple

Class SimpleShell

java.lang.Object

org.dellroad.jct.core.simple.SimpleCommandSupport

org.dellroad.jct.core.simple.SimpleShell

All Implemented Interfaces:

Shell

public class SimpleShell
extends SimpleCommandSupport
implements Shell

A simple implementation of the Shell interface based on a library of SimpleCommands.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleShell.Session	Default ShellSession implementation used by SimpleShell.
protected class	SimpleShell.SimpleCompleter	A simple Completer for command names.

Nested classes/interfaces inherited from class org.dellroad.jct.core.simple.SimpleCommandSupport

SimpleCommandSupport.FoundCommand

Field Summary

Fields inherited from class org.dellroad.jct.core.simple.SimpleCommandSupport

commandBundles, commandLineParser

Constructor Summary

Constructors

Constructor	Description
SimpleShell()

Method Summary

Modifier and Type	Method	Description
protected org.jline.reader.LineReader	buildLineReader(ShellRequest request)	Construct a LineReader for a new shell session.
protected org.jline.reader.LineReaderBuilder	createLineReaderBuilder(ShellRequest request)	Create and configure a LineReaderBuilder for a new shell session.
String	getContinuationPrompt()	Get the continuation line prompt.
String	getGreeting()	Get the welcome greeting.
String	getNormalPrompt()	Get the normal prompt.
ShellSession	newShellSession(ShellRequest request)	Create a new interactive shell session.
ShellSession	newShellSession(ShellRequest request, org.jline.reader.LineReader reader)	Alternate ssession creator for when a LineReader is already constructed.

Methods inherited from class org.dellroad.jct.core.simple.SimpleCommandSupport

buildCommandMap, findCommand, findCommand, findCommand, getCommandBundles, getCommandLineParser, setCommandLineParser

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleShell

public SimpleShell()

Method Details

newShellSession

public ShellSession newShellSession(ShellRequest request)
                             throws IOException

Description copied from interface: Shell

Create a new interactive shell session.

If the request fails, this method should return null and write an error message to request.getTerminal().

Specified by:

newShellSession in interface Shell

Parameters:

request - interactive shell request

Returns:

interactive session, or null on failure

Throws:

IOException - if an I/O error occurs

newShellSession

public ShellSession newShellSession(ShellRequest request,
 org.jline.reader.LineReader reader)
                             throws IOException

Alternate ssession creator for when a LineReader is already constructed.

Parameters:

request - session request

reader - console line reader

Returns:

new session

Throws:

IOException - if an I/O error occurs

IllegalArgumentException - if any parameter is null

getGreeting

public String getGreeting()

Get the welcome greeting.

Returns:

welcome greeting, or null for none

getNormalPrompt

public String getNormalPrompt()

Get the normal prompt.

Returns:

the normal prompt

getContinuationPrompt

public String getContinuationPrompt()

Get the continuation line prompt.

Returns:

the continuation line prompt

buildLineReader

protected org.jline.reader.LineReader buildLineReader(ShellRequest request)

Construct a LineReader for a new shell session.

The implementation in SimpleShell invokes createLineReaderBuilder(org.dellroad.jct.core.ShellRequest) to create and configure the builder, then just returns LineReaderBuilder.build().

Parameters:

request - associated shell request

Returns:

new terminal line reader

createLineReaderBuilder

protected org.jline.reader.LineReaderBuilder createLineReaderBuilder(ShellRequest request)

Create and configure a LineReaderBuilder for a new shell session.

Parameters:

request - associated shell request

Returns:

builder for terminal line reader