org.crsh.shell

Interface Shell

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AsyncShell, ServerAutomaton

public interface Shell
extends Closeable

Method Summary

Methods

Modifier and Type	Method and Description
org.crsh.cli.impl.completion.CompletionMatch	complete(String prefix) Completion.
ShellProcess	createProcess(String request) Process a request.
String	getPrompt() Returns the shell prompt.
String	getWelcome() Returns the welcome message.

Methods inherited from interface java.io.Closeable

close

Method Detail

getWelcome

String getWelcome()

Returns the welcome message.

Returns:

the welcome message

getPrompt

String getPrompt()

Returns the shell prompt.

Returns:

the shell prompt

createProcess

ShellProcess createProcess(String request)
                           throws IllegalStateException

Process a request.

Parameters:

request - the request to process

Returns:

the process

Throws:

IllegalStateException - if the shell cannot create a process

complete

org.crsh.cli.impl.completion.CompletionMatch complete(String prefix)

Completion.

Parameters:

prefix - the prefix to complete

Returns:

the sorted list of available suffixes