Package org.jline.shell

Class Shell

java.lang.Object

org.jline.shell.Shell

All Implemented Interfaces:

AutoCloseable

public class Shell
extends Object
implements AutoCloseable

An interactive shell that runs a read-eval-print loop (REPL) using a CommandDispatcher for command execution.

The shell is a thin REPL loop. The dispatcher is injected or auto-created as a DefaultCommandDispatcher.

Use builder() to create a shell:

 Shell shell = Shell.builder()
     .terminal(terminal)
     .prompt("myapp> ")
     .dispatcher(dispatcher)
     .groups(group1, group2)
     .build();
 shell.run();
 

Since:

4.0

See Also:

• ShellBuilder
• CommandDispatcher

Method Summary

Modifier and Type	Method	Description
static ShellBuilder	builder()	Creates a new ShellBuilder.
void	close()	Closes this shell, releasing the dispatcher and optionally the terminal.
CommandDispatcher	dispatcher()	Returns the command dispatcher used by this shell.
boolean	isRunning()	Returns whether the shell is currently running.
LineReader	reader()	Returns the line reader used by this shell.
void	run()	Runs the interactive REPL loop.
void	stop()	Stops the REPL loop.
Terminal	terminal()	Returns the terminal used by this shell.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static ShellBuilder builder()

Creates a new ShellBuilder.

Returns:

a new shell builder

run

public void run()
         throws Exception

Runs the interactive REPL loop.

This method blocks until the user exits (via EOF or an "exit"/"quit" command), or until stop() is called.

Throws:

Exception - if initialization or execution fails

stop

public void stop()

Stops the REPL loop. The current or next iteration will exit.

isRunning

public boolean isRunning()

Returns whether the shell is currently running.

Returns:

true if running

terminal

public Terminal terminal()

Returns the terminal used by this shell.

Returns:

the terminal

reader

public LineReader reader()

Returns the line reader used by this shell.

Returns:

the line reader

dispatcher

public CommandDispatcher dispatcher()

Returns the command dispatcher used by this shell.

Returns:

the command dispatcher

close

public void close()

Closes this shell, releasing the dispatcher and optionally the terminal.

Specified by:

close in interface AutoCloseable