- java.lang.Object
-
- org.jline.shell.Shell
-
- All Implemented Interfaces:
java.lang.AutoCloseable
public class Shell extends java.lang.Object implements java.lang.AutoCloseableAn interactive shell that runs a read-eval-print loop (REPL) using aCommandDispatcherfor 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ShellBuilderbuilder()Creates a newShellBuilder.voidclose()Closes this shell, releasing the dispatcher and optionally the terminal.CommandDispatcherdispatcher()Returns the command dispatcher used by this shell.booleanisRunning()Returns whether the shell is currently running.org.jline.reader.LineReaderreader()Returns the line reader used by this shell.voidrun()Runs the interactive REPL loop.voidstop()Stops the REPL loop.org.jline.terminal.Terminalterminal()Returns the terminal used by this shell.
-
-
-
Method Detail
-
builder
public static ShellBuilder builder()
Creates a newShellBuilder.- Returns:
- a new shell builder
-
run
public void run() throws java.lang.ExceptionRuns the interactive REPL loop.This method blocks until the user exits (e.g. via EOF or an exit command), or until
stop()is called.- Throws:
java.lang.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 org.jline.terminal.Terminal terminal()
Returns the terminal used by this shell.- Returns:
- the terminal
-
reader
public org.jline.reader.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:
closein interfacejava.lang.AutoCloseable
-
-