Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractCommand - Class in org.jline.shell.impl

Base implementation of Command that stores name and aliases.

AbstractCommand(String, String...) - Constructor for class org.jline.shell.impl.AbstractCommand

Creates a new command with the given name and optional aliases.

addGroup(CommandGroup) - Method in interface org.jline.shell.CommandDispatcher

Adds a command group to this dispatcher.

addGroup(CommandGroup) - Method in class org.jline.shell.impl.DefaultCommandDispatcher

addJobListener(JobListener) - Method in class org.jline.shell.impl.DefaultJobManager

addJobListener(JobListener) - Method in interface org.jline.shell.JobManager

Adds a job listener.

AliasCommands - Class in org.jline.shell.impl

Built-in alias commands: alias and unalias.

AliasCommands(AliasManager) - Constructor for class org.jline.shell.impl.AliasCommands

Creates alias commands backed by the given alias manager.

aliases() - Method in interface org.jline.shell.AliasManager

Returns all defined aliases.

aliases() - Method in interface org.jline.shell.Command

Returns alternative names for this command.

aliases() - Method in class org.jline.shell.impl.AbstractCommand

aliases() - Method in class org.jline.shell.impl.DefaultAliasManager

aliasManager(AliasManager) - Method in class org.jline.shell.ShellBuilder

Sets the alias manager for the shell.

AliasManager - Interface in org.jline.shell

Manages command aliases for the shell.

and(String) - Method in class org.jline.shell.PipelineBuilder

Adds a conditional AND (&&) to the next command.

AND - Enum constant in enum class org.jline.shell.Pipeline.Operator

Logical AND: execute next command only if previous succeeded (&&)

append(Path) - Method in class org.jline.shell.PipelineBuilder

Adds an append redirection (>>) to the specified file.

APPEND - Enum constant in enum class org.jline.shell.Pipeline.Operator

Append redirection: append output to file (>>)

Architecture - Search tag in package org.jline.shell

Section

args() - Method in class org.jline.shell.CommandLine

Returns the parsed arguments.

argument(ArgumentDescription) - Method in class org.jline.shell.CommandDescription.Builder

Adds an argument description.

ArgumentDescription - Class in org.jline.shell

Describes a command argument with a name and optional description.

ArgumentDescription(String) - Constructor for class org.jline.shell.ArgumentDescription

Creates a new argument description with the specified name and an empty description.

ArgumentDescription(String, List<AttributedString>) - Constructor for class org.jline.shell.ArgumentDescription

Creates a new argument description with the specified name and description.

arguments() - Method in class org.jline.shell.CommandDescription

Returns the argument descriptions.

arguments(List<ArgumentDescription>) - Method in class org.jline.shell.CommandDescription.Builder

Sets all argument descriptions.

autopairClose() - Method in class org.jline.shell.widget.AutopairWidgets

autopairDelete() - Method in class org.jline.shell.widget.AutopairWidgets

autopairInsert() - Method in class org.jline.shell.widget.AutopairWidgets

AutopairWidgets - Class in org.jline.shell.widget

Provides intelligent auto-pairing of matching delimiters in the command line.

AutopairWidgets(LineReader) - Constructor for class org.jline.shell.widget.AutopairWidgets

Creates autopair widgets without curly brace support.

AutopairWidgets(LineReader, boolean) - Constructor for class org.jline.shell.widget.AutopairWidgets

Creates autopair widgets with optional curly brace support.

B

background() - Method in class org.jline.shell.PipelineBuilder

Marks this pipeline for background execution.

Background - Enum constant in enum class org.jline.shell.Job.Status

Job is running in the background

build() - Method in class org.jline.shell.CommandDescription.Builder

Builds the command description.

build() - Method in class org.jline.shell.PipelineBuilder

Builds the pipeline.

build() - Method in class org.jline.shell.ShellBuilder

Builds the Shell instance.

builder() - Static method in class org.jline.shell.CommandDescription

Creates a new builder.

builder() - Static method in class org.jline.shell.Shell

Creates a new ShellBuilder.

C

cleanUp() - Method in interface org.jline.shell.CommandDispatcher

Performs cleanup between command executions (e.g., resetting state).

close() - Method in interface org.jline.shell.CommandDispatcher

Closes this dispatcher and releases resources.

close() - Method in class org.jline.shell.impl.DefaultCommandDispatcher

No-op default implementation; does nothing.

close() - Method in class org.jline.shell.Shell

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

COMBINED - Enum constant in enum class org.jline.shell.widget.CommandTailTipWidgets.TipType

Show argument descriptions if available, otherwise completer suggestions.

COMBINED_REDIRECT - Enum constant in enum class org.jline.shell.Pipeline.Operator

Combined redirection: redirect both stdout and stderr to file (&>)

combinedRedirect(Path) - Method in class org.jline.shell.PipelineBuilder

Adds a combined stdout+stderr redirection (&>) to the specified file.

command() - Method in class org.jline.shell.impl.DefaultJob

command() - Method in interface org.jline.shell.Job

Returns the command string associated with this job.

command(boolean) - Method in class org.jline.shell.CommandDescription.Builder

Sets whether this description represents a command.

command(String) - Method in interface org.jline.shell.CommandGroup

Finds a command by name or alias.

command(String) - Method in class org.jline.shell.impl.VariableCommands

Command - Interface in org.jline.shell

Represents a single executable command in the shell.

COMMAND - Enum constant in enum class org.jline.shell.CommandLine.Type

Full command description

CommandDescription - Class in org.jline.shell

Describes a command for help display and widget integration.

CommandDescription.Builder - Class in org.jline.shell

Builder for CommandDescription instances.

CommandDispatcher - Interface in org.jline.shell

Central dispatcher that aggregates CommandGroups and handles command resolution, execution, and completion.

CommandGroup - Interface in org.jline.shell

A named group of Commands for organization and discovery.

commandHighlighter(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables the built-in command-aware syntax highlighter.

CommandHighlighter - Class in org.jline.shell.impl

Command-aware syntax highlighter for the shell.

CommandHighlighter(CommandDispatcher) - Constructor for class org.jline.shell.impl.CommandHighlighter

Creates a command highlighter with no delegate.

CommandHighlighter(CommandDispatcher, Highlighter) - Constructor for class org.jline.shell.impl.CommandHighlighter

Creates a command highlighter with an optional delegate.

commandLine() - Method in class org.jline.shell.impl.DefaultPipeline.DefaultStage

commandLine() - Method in interface org.jline.shell.Pipeline.Stage

Returns the command line for this stage.

CommandLine - Class in org.jline.shell

Represents a parsed command line with its components.

CommandLine(String, String, String, List<String>, CommandLine.Type) - Constructor for class org.jline.shell.CommandLine

Creates a new command line.

CommandLine.Type - Enum Class in org.jline.shell

The type of description that should be displayed.

commands() - Method in interface org.jline.shell.CommandGroup

Returns all commands in this group.

commands() - Method in class org.jline.shell.impl.ScriptCommands

commands() - Method in class org.jline.shell.impl.SimpleCommandGroup

commands() - Method in class org.jline.shell.impl.VariableCommands

CommandSession - Class in org.jline.shell

Encapsulates the execution context for a command, including the terminal, I/O streams, session variables, working directory, and job state.

CommandSession() - Constructor for class org.jline.shell.CommandSession

Creates a new command session with the system's standard I/O streams.

CommandSession(Terminal) - Constructor for class org.jline.shell.CommandSession

Creates a new command session with the specified terminal.

CommandSession(Terminal, InputStream, PrintStream, PrintStream) - Constructor for class org.jline.shell.CommandSession

Creates a new command session with the specified terminal and I/O streams.

CommandTailTipWidgets - Class in org.jline.shell.widget

Provides real-time command-line suggestions as the user types, using CommandDescription for positional argument hints and option help.

CommandTailTipWidgets(LineReader, Function<CommandLine, CommandDescription>, int, CommandTailTipWidgets.TipType) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a dynamic description function.

CommandTailTipWidgets(LineReader, Map<String, CommandDescription>) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a static map of command descriptions.

CommandTailTipWidgets(LineReader, Map<String, CommandDescription>, int) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a static map with a status bar.

CommandTailTipWidgets(LineReader, Map<String, CommandDescription>, int, CommandTailTipWidgets.TipType) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a static map with full configuration.

CommandTailTipWidgets(LineReader, Map<String, CommandDescription>, CommandTailTipWidgets.TipType) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a static map with a specific tip type.

CommandTailTipWidgets(LineReader, CommandDispatcher) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a CommandDispatcher for dynamic description lookup.

CommandTailTipWidgets(LineReader, CommandDispatcher, int) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a CommandDispatcher with a status bar.

CommandTailTipWidgets(LineReader, CommandDispatcher, int, CommandTailTipWidgets.TipType) - Constructor for class org.jline.shell.widget.CommandTailTipWidgets

Creates widgets using a CommandDispatcher with full configuration.

CommandTailTipWidgets.TipType - Enum Class in org.jline.shell.widget

The type of suggestions to display.

completeJob(DefaultJob) - Method in class org.jline.shell.impl.DefaultJobManager

Marks a job as done and fires listeners.

completer() - Method in interface org.jline.shell.Command

Returns a single completer for this command's arguments.

completer() - Method in interface org.jline.shell.CommandDispatcher

Returns a completer that provides tab completion across all registered commands.

completer() - Method in class org.jline.shell.impl.DefaultCommandDispatcher

Creates a completer that provides completions for every registered command name and its aliases.

COMPLETER - Enum constant in enum class org.jline.shell.widget.CommandTailTipWidgets.TipType

Show completer-driven suggestions.

completers() - Method in interface org.jline.shell.Command

Returns the completers for this command's arguments.

Core Types - Search tag in package org.jline.shell

Section

createJob(String, Thread) - Method in class org.jline.shell.impl.DefaultJobManager

Creates a new foreground job for the given command and thread.

D

DefaultAliasManager - Class in org.jline.shell.impl

Default in-memory implementation of AliasManager with optional file persistence.

DefaultAliasManager() - Constructor for class org.jline.shell.impl.DefaultAliasManager

Creates an in-memory alias manager with no persistence.

DefaultAliasManager(Path) - Constructor for class org.jline.shell.impl.DefaultAliasManager

Creates an alias manager with optional file persistence.

DefaultCommandDispatcher - Class in org.jline.shell.impl

Default implementation of CommandDispatcher that supports pipeline execution.

DefaultCommandDispatcher(LineReader) - Constructor for class org.jline.shell.impl.DefaultCommandDispatcher

Creates a new dispatcher for the given reader.

DefaultCommandDispatcher(Terminal) - Constructor for class org.jline.shell.impl.DefaultCommandDispatcher

Creates a new dispatcher for the given terminal.

DefaultCommandDispatcher(Terminal, JobManager) - Constructor for class org.jline.shell.impl.DefaultCommandDispatcher

Creates a new dispatcher for the given terminal with optional job management.

DefaultCommandDispatcher(Terminal, JobManager, PipelineParser, AliasManager) - Constructor for class org.jline.shell.impl.DefaultCommandDispatcher

Creates a new dispatcher with all configuration options.

DefaultCommandDispatcher(Terminal, JobManager, PipelineParser, AliasManager, LineExpander, ScriptRunner) - Constructor for class org.jline.shell.impl.DefaultCommandDispatcher

Creates a new dispatcher with all configuration options including line expansion and script execution.

DefaultCommandDispatcher(Terminal, JobManager, PipelineParser, AliasManager, LineExpander, ScriptRunner, Parser) - Constructor for class org.jline.shell.impl.DefaultCommandDispatcher

Creates a new dispatcher with all configuration options including line expansion, script execution and parser.

DefaultJob - Class in org.jline.shell.impl

Default implementation of Job.

DefaultJob(long, String, Thread) - Constructor for class org.jline.shell.impl.DefaultJob

Creates a new job.

DefaultJobManager - Class in org.jline.shell.impl

Default implementation of JobManager.

DefaultJobManager() - Constructor for class org.jline.shell.impl.DefaultJobManager

Creates a new DefaultJobManager.

DefaultLineExpander - Class in org.jline.shell.impl

Default implementation of LineExpander that provides sane defaults for variable expansion.

DefaultLineExpander() - Constructor for class org.jline.shell.impl.DefaultLineExpander

Creates a new DefaultLineExpander.

DefaultPipeline - Class in org.jline.shell.impl

Default implementation of Pipeline.

DefaultPipeline(List<Pipeline.Stage>, String, boolean) - Constructor for class org.jline.shell.impl.DefaultPipeline

Creates a new pipeline.

DefaultPipeline.DefaultStage - Class in org.jline.shell.impl

Default implementation of Pipeline.Stage.

DefaultScriptRunner - Class in org.jline.shell.impl

Default implementation of ScriptRunner that reads a script file line by line and executes each line through the dispatcher.

DefaultScriptRunner() - Constructor for class org.jline.shell.impl.DefaultScriptRunner

Creates a new DefaultScriptRunner.

DefaultStage(String, Pipeline.Operator, Path, boolean) - Constructor for class org.jline.shell.impl.DefaultPipeline.DefaultStage

Creates a new stage.

DefaultStage(String, Pipeline.Operator, Path, boolean, Path) - Constructor for class org.jline.shell.impl.DefaultPipeline.DefaultStage

Creates a new stage with input source.

describe(List<String>) - Method in interface org.jline.shell.Command

Returns a detailed description of this command for the given arguments.

describe(CommandLine) - Method in interface org.jline.shell.CommandDispatcher

Returns a description for the command at the current command line position.

describe(CommandLine) - Method in class org.jline.shell.impl.DefaultCommandDispatcher

description() - Method in class org.jline.shell.ArgumentDescription

Returns the argument description lines.

description() - Method in interface org.jline.shell.Command

Returns a short, one-line description of this command.

descriptionSize() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Returns the current status bar size.

disable() - Method in class org.jline.shell.widget.AutopairWidgets

Disables auto-pairing if currently enabled.

disable() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Disables the widgets, restoring default key bindings.

dispatcher() - Method in class org.jline.shell.Shell

Returns the command dispatcher used by this shell.

dispatcher(CommandDispatcher) - Method in class org.jline.shell.ShellBuilder

Sets the command dispatcher.

Done - Enum constant in enum class org.jline.shell.Job.Status

Job has completed execution

E

enable() - Method in class org.jline.shell.widget.AutopairWidgets

Enables auto-pairing if not already enabled.

enable() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Enables the widgets, installing custom key bindings.

err() - Method in class org.jline.shell.CommandSession

Returns the error stream.

errorIndex() - Method in class org.jline.shell.CommandDescription

Returns the error index, or -1 if none.

errorIndex(int) - Method in class org.jline.shell.CommandDescription.Builder

Sets the error index.

errorPattern() - Method in class org.jline.shell.CommandDescription

Returns the pattern for identifying errors, or null.

errorPattern(Pattern) - Method in class org.jline.shell.CommandDescription.Builder

Sets the error pattern.

errorStyle() - Method in interface org.jline.shell.CommandDispatcher

execute(String) - Method in interface org.jline.shell.CommandDispatcher

Executes a command line string.

execute(String) - Method in class org.jline.shell.impl.DefaultCommandDispatcher

execute(Path, CommandSession, CommandDispatcher) - Method in class org.jline.shell.impl.DefaultScriptRunner

execute(Path, CommandSession, CommandDispatcher) - Method in interface org.jline.shell.ScriptRunner

Executes a script file.

execute(CommandSession, String[]) - Method in interface org.jline.shell.Command

Executes this command with the given session and arguments.

execute(Pipeline) - Method in interface org.jline.shell.CommandDispatcher

Executes a pre-parsed pipeline.

execute(Pipeline) - Method in class org.jline.shell.impl.DefaultCommandDispatcher

exitCommands(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables built-in exit commands (exit, quit).

ExitCommands - Class in org.jline.shell.impl

Built-in exit command.

ExitCommands() - Constructor for class org.jline.shell.impl.ExitCommands

ExitCommands(String) - Constructor for class org.jline.shell.impl.ExitCommands

exitMessage(String) - Method in class org.jline.shell.ShellBuilder

Sets the message that will be printed to the terminal when the exit command is called.

ExitShellException - Exception Class in org.jline.shell

This exception is thrown by commands (e.g.

ExitShellException() - Constructor for exception class org.jline.shell.ExitShellException

ExitShellException(int) - Constructor for exception class org.jline.shell.ExitShellException

ExitShellException(String) - Constructor for exception class org.jline.shell.ExitShellException

ExitShellException(String, int) - Constructor for exception class org.jline.shell.ExitShellException

expand(String) - Method in interface org.jline.shell.AliasManager

Expands aliases in a command line string.

expand(String) - Method in class org.jline.shell.impl.DefaultAliasManager

expand(String, CommandSession) - Method in class org.jline.shell.impl.DefaultLineExpander

expand(String, CommandSession) - Method in interface org.jline.shell.LineExpander

Expands variables and expressions in the given command line.

expandBracedExpression(String, CommandSession) - Method in class org.jline.shell.impl.DefaultLineExpander

Expands a braced expression such as VAR, VAR:-default, VAR:=default, VAR:+alt, or VAR:?error.

F

fillInStackTrace() - Method in exception class org.jline.shell.ExitShellException

findCommand(String) - Method in interface org.jline.shell.CommandDispatcher

Finds a command by name or alias across all registered groups.

flip(String) - Method in class org.jline.shell.PipelineBuilder

Adds a flip pipe (|;) to the next command.

FLIP - Enum constant in enum class org.jline.shell.Pipeline.Operator

Flip pipe: appends output as argument to next command (|;)

Foreground - Enum constant in enum class org.jline.shell.Job.Status

Job is running in the foreground

foregroundJob() - Method in class org.jline.shell.CommandSession

Returns the current foreground job.

foregroundJob() - Method in class org.jline.shell.impl.DefaultJobManager

foregroundJob() - Method in interface org.jline.shell.JobManager

Returns the current foreground job, or null if no job is in the foreground.

fork(InputStream, PrintStream, PrintStream) - Method in class org.jline.shell.CommandSession

Creates a child session that shares the same terminal but uses independent I/O streams.

fromSymbol(String) - Static method in enum class org.jline.shell.Pipeline.Operator

Returns the operator matching the given symbol, or null if none matches.

G

get(long) - Method in class org.jline.shell.impl.DefaultJobManager

get(long) - Method in interface org.jline.shell.JobManager

Returns the job with the specified id, or null if not found.

get(String) - Method in class org.jline.shell.CommandSession

Returns the value of a session variable.

getAlias(String) - Method in interface org.jline.shell.AliasManager

Returns the expansion for an alias.

getAlias(String) - Method in class org.jline.shell.impl.DefaultAliasManager

getExitCode() - Method in exception class org.jline.shell.ExitShellException

groups() - Method in interface org.jline.shell.CommandDispatcher

Returns all registered command groups.

groups() - Method in class org.jline.shell.impl.DefaultCommandDispatcher

groups(CommandGroup...) - Method in class org.jline.shell.ShellBuilder

Adds command groups to the dispatcher.

H

hasCommand(String) - Method in interface org.jline.shell.CommandGroup

Returns whether this group contains a command with the given name or alias.

head() - Method in class org.jline.shell.CommandLine

Returns the part before the cursor.

helpCommands(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables built-in help commands (help).

HelpCommands - Class in org.jline.shell.impl

Built-in help command group.

HelpCommands(CommandDispatcher) - Constructor for class org.jline.shell.impl.HelpCommands

Creates help commands using the given dispatcher for command discovery.

HEREDOC - Enum constant in enum class org.jline.shell.Pipeline.Operator

Here-document: provide stdin inline (<<)

highlight(LineReader, String) - Method in class org.jline.shell.impl.CommandHighlighter

highlighted(boolean) - Method in class org.jline.shell.CommandDescription.Builder

Sets whether the command should be highlighted.

highlighter(Highlighter) - Method in class org.jline.shell.ShellBuilder

Sets a custom highlighter for the shell's LineReader.

historyCommands(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables built-in history commands (history).

HistoryCommands - Class in org.jline.shell.impl

Built-in history command group.

HistoryCommands(LineReader) - Constructor for class org.jline.shell.impl.HistoryCommands

Creates history commands using the given line reader's history.

historyFile(Path) - Method in class org.jline.shell.ShellBuilder

Sets the history file path.

I

id() - Method in class org.jline.shell.impl.DefaultJob

id() - Method in interface org.jline.shell.Job

Returns the unique identifier for this job.

in() - Method in class org.jline.shell.CommandSession

Returns the input stream.

initDescription() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Initializes the terminal status bar with a border.

initialize(File) - Method in interface org.jline.shell.CommandDispatcher

Initializes the dispatcher, optionally executing a startup script.

initialize(File) - Method in class org.jline.shell.impl.DefaultCommandDispatcher

initScript(File) - Method in class org.jline.shell.ShellBuilder

Sets the initialization script to execute on startup.

INPUT_REDIRECT - Enum constant in enum class org.jline.shell.Pipeline.Operator

Input redirection: read stdin from file (<)

inputRedirect(Path) - Method in class org.jline.shell.PipelineBuilder

Adds an input redirection (<) from the specified file.

inputSource() - Method in class org.jline.shell.impl.DefaultPipeline.DefaultStage

inputSource() - Method in interface org.jline.shell.Pipeline.Stage

Returns the input source path, if this stage has an INPUT_REDIRECT operator.

interrupt() - Method in class org.jline.shell.impl.DefaultJob

interrupt() - Method in interface org.jline.shell.Job

Interrupts this job.

interruptCurrentCommand() - Method in class org.jline.shell.impl.DefaultCommandDispatcher

Interrupts the currently executing command, if any.

isAppend() - Method in class org.jline.shell.impl.DefaultPipeline.DefaultStage

isAppend() - Method in interface org.jline.shell.Pipeline.Stage

Returns whether this is an append redirection (>>).

isBackground() - Method in class org.jline.shell.impl.DefaultPipeline

isBackground() - Method in interface org.jline.shell.Pipeline

Returns whether this pipeline should execute in the background.

isCommand() - Method in class org.jline.shell.CommandDescription

Returns whether this description represents a command (as opposed to a method or syntax).

isEnabled() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Returns whether the widgets are currently enabled.

isHighlighted() - Method in class org.jline.shell.CommandDescription

Returns whether the command should be highlighted.

isOperator - Variable in class org.jline.shell.impl.PipelineParser.Token

Whether this token represents an operator.

isRunning() - Method in class org.jline.shell.Shell

Returns whether the shell is currently running.

isSubcommand() - Method in class org.jline.shell.CommandDescription

Returns whether this description represents a subcommand.

isValid() - Method in class org.jline.shell.CommandDescription

Returns whether this description represents a valid command.

J

Job - Interface in org.jline.shell

Represents a job in the shell's job control system.

Job.Status - Enum Class in org.jline.shell

Job lifecycle status.

JobCommands - Class in org.jline.shell.impl

Built-in job control commands: jobs, fg, and bg.

JobCommands(JobManager) - Constructor for class org.jline.shell.impl.JobCommands

Creates job control commands backed by the given job manager.

JobListener - Interface in org.jline.shell

Listener for job status changes.

jobManager(JobManager) - Method in class org.jline.shell.ShellBuilder

Sets the job manager for the shell.

JobManager - Interface in org.jline.shell

Manages jobs in the shell's job control system.

jobs() - Method in class org.jline.shell.impl.DefaultJobManager

jobs() - Method in interface org.jline.shell.JobManager

Returns all tracked jobs.

K

Key Types - Search tag in package org.jline.shell.widget

Section

L

lastExitCode() - Method in class org.jline.shell.CommandSession

Returns the exit code of the last executed command.

line() - Method in class org.jline.shell.CommandLine

Returns the original command line.

lineExpander(LineExpander) - Method in class org.jline.shell.ShellBuilder

Sets the line expander for variable expansion.

LineExpander - Interface in org.jline.shell

Expands variables and other expressions in a command line before parsing.

load() - Method in interface org.jline.shell.AliasManager

Loads aliases from persistent storage.

load() - Method in class org.jline.shell.impl.DefaultAliasManager

M

mainDescription() - Method in class org.jline.shell.CommandDescription

Returns the main description lines.

mainDescription(List<AttributedString>) - Method in class org.jline.shell.CommandDescription.Builder

Sets the main description.

matchOperator(String, int) - Method in class org.jline.shell.impl.PipelineParser

Tries to match a pipeline operator at the given position.

METHOD - Enum constant in enum class org.jline.shell.CommandLine.Type

Method/function parameter description

N

name() - Method in class org.jline.shell.ArgumentDescription

Returns the argument name.

name() - Method in interface org.jline.shell.Command

Returns the primary name of this command.

name() - Method in interface org.jline.shell.CommandGroup

Returns the name of this command group.

name() - Method in class org.jline.shell.impl.AbstractCommand

name() - Method in class org.jline.shell.impl.ScriptCommands

name() - Method in class org.jline.shell.impl.SimpleCommandGroup

name() - Method in class org.jline.shell.impl.VariableCommands

O

of(String) - Static method in interface org.jline.shell.Pipeline

Starts building a new pipeline with the given command.

of(String...) - Static method in class org.jline.shell.ArgumentDescription

Creates a list of argument descriptions from names.

onChange(Job, Job.Status, Job.Status) - Method in interface org.jline.shell.JobListener

Called when a job's status changes.

onReaderReady(BiConsumer<LineReader, CommandDispatcher>) - Method in class org.jline.shell.ShellBuilder

Sets a callback invoked after the LineReader is created but before Shell.run().

onReaderReady(Consumer<LineReader>) - Method in class org.jline.shell.ShellBuilder

Sets a callback invoked after the LineReader is created but before Shell.run().

operator() - Method in class org.jline.shell.impl.DefaultPipeline.DefaultStage

operator() - Method in interface org.jline.shell.Pipeline.Stage

Returns the operator that follows this stage, or null for the last stage.

option(String, List<AttributedString>) - Method in class org.jline.shell.CommandDescription.Builder

Adds an option with its description.

option(LineReader.Option, boolean) - Method in class org.jline.shell.ShellBuilder

Sets a LineReader option.

optionCommands(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables built-in option commands (setopt, unsetopt, setvar).

OptionCommands - Class in org.jline.shell.impl

Built-in option management commands: setopt, unsetopt, and setvar.

OptionCommands(LineReader) - Constructor for class org.jline.shell.impl.OptionCommands

Creates option commands for the given line reader.

optionDescription(String) - Method in class org.jline.shell.CommandDescription

Returns the first line of description for the specified option key.

options() - Method in class org.jline.shell.CommandDescription

Returns the option descriptions, keyed by option syntax.

options(Map<String, List<AttributedString>>) - Method in class org.jline.shell.CommandDescription.Builder

Sets all options.

optionWithValue(String) - Method in class org.jline.shell.CommandDescription

Returns whether the specified option takes a value.

or(String) - Method in class org.jline.shell.PipelineBuilder

Adds a conditional OR (||) to the next command.

OR - Enum constant in enum class org.jline.shell.Pipeline.Operator

Logical OR: execute next command only if previous failed (||)

org.jline.shell - module org.jline.shell

JLine Shell Module.

org.jline.shell - package org.jline.shell

Clean shell API for building interactive command-line applications with JLine.

org.jline.shell.impl - package org.jline.shell.impl

Default implementations of the shell API interfaces.

org.jline.shell.widget - package org.jline.shell.widget

Widgets for the JLine shell API.

out() - Method in class org.jline.shell.CommandSession

Returns the output stream.

P

parse(String) - Method in class org.jline.shell.impl.PipelineParser

Parses a command line into a Pipeline.

parser(Parser) - Method in class org.jline.shell.ShellBuilder

Sets the line parser.

pipe(String) - Method in class org.jline.shell.PipelineBuilder

Adds a pipe (|) to the next command.

PIPE - Enum constant in enum class org.jline.shell.Pipeline.Operator

Standard pipe: sends output of left command to right command (|)

Pipeline - Interface in org.jline.shell

Represents a pipeline of commands connected by operators such as pipes, redirections, and conditional connectors.

Pipeline.Operator - Enum Class in org.jline.shell

Operators that connect commands in a pipeline.

Pipeline.Stage - Interface in org.jline.shell

A single stage in a pipeline, consisting of a command line and the operator that follows it.

PipelineBuilder - Class in org.jline.shell

Fluent builder for constructing Pipeline instances programmatically.

pipelineParser(PipelineParser) - Method in class org.jline.shell.ShellBuilder

Sets a custom pipeline parser for the shell.

PipelineParser - Class in org.jline.shell.impl

Parses a command line string into a Pipeline.

PipelineParser() - Constructor for class org.jline.shell.impl.PipelineParser

Creates a new PipelineParser with default operator symbols from Pipeline.Operator.

PipelineParser(Map<String, Pipeline.Operator>) - Constructor for class org.jline.shell.impl.PipelineParser

Creates a new PipelineParser with custom operator symbol mappings.

PipelineParser.Token - Class in org.jline.shell.impl

A token from tokenization -- either text or an operator.

prompt(String) - Method in class org.jline.shell.ShellBuilder

Sets a static prompt string.

prompt(Supplier<String>) - Method in class org.jline.shell.ShellBuilder

Sets a dynamic prompt supplier, called before each line read.

Public API Packages - Search tag in module org.jline.shell

Section

put(String, Object) - Method in class org.jline.shell.CommandSession

Sets a session variable.

Q

Quick Start - Search tag in package org.jline.shell

Section

R

reader - Variable in class org.jline.shell.widget.AutopairWidgets

reader - Variable in class org.jline.shell.widget.CommandTailTipWidgets

reader() - Method in class org.jline.shell.Shell

Returns the line reader used by this shell.

redirect(Path) - Method in class org.jline.shell.PipelineBuilder

Adds an output redirection (>) to the specified file.

REDIRECT - Enum constant in enum class org.jline.shell.Pipeline.Operator

Output redirection: write output to file (>)

redirectTarget() - Method in class org.jline.shell.impl.DefaultPipeline.DefaultStage

redirectTarget() - Method in interface org.jline.shell.Pipeline.Stage

Returns the redirect target path, if this stage has a REDIRECT or APPEND operator.

remove(String) - Method in class org.jline.shell.CommandSession

Removes a session variable.

removeAlias(String) - Method in interface org.jline.shell.AliasManager

Removes an alias.

removeAlias(String) - Method in class org.jline.shell.impl.DefaultAliasManager

removeJob(Job) - Method in class org.jline.shell.impl.DefaultJobManager

Removes a job from the managed list.

removeJobListener(JobListener) - Method in class org.jline.shell.impl.DefaultJobManager

removeJobListener(JobListener) - Method in interface org.jline.shell.JobManager

Removes a job listener.

resolve(String, CommandSession) - Method in class org.jline.shell.impl.DefaultLineExpander

Resolves a variable name to its value.

resume(boolean) - Method in class org.jline.shell.impl.DefaultJob

resume(boolean) - Method in interface org.jline.shell.Job

Resumes this job.

rightPrompt(String) - Method in class org.jline.shell.ShellBuilder

Sets a static right prompt string.

rightPrompt(Supplier<String>) - Method in class org.jline.shell.ShellBuilder

Sets a dynamic right prompt supplier, called before each line read.

run() - Method in class org.jline.shell.Shell

Runs the interactive REPL loop.

S

save() - Method in interface org.jline.shell.AliasManager

Saves aliases to persistent storage.

save() - Method in class org.jline.shell.impl.DefaultAliasManager

scriptCommands(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables built-in script commands (source, .).

ScriptCommands - Class in org.jline.shell.impl

Built-in commands for script execution.

ScriptCommands(ScriptRunner, CommandDispatcher) - Constructor for class org.jline.shell.impl.ScriptCommands

Creates the script commands group.

scriptRunner(ScriptRunner) - Method in class org.jline.shell.ShellBuilder

Sets the script runner for executing script files.

ScriptRunner - Interface in org.jline.shell

Executes a script file line by line through a CommandDispatcher.

sequence(String) - Method in class org.jline.shell.PipelineBuilder

Adds a sequence separator (;) to the next command.

SEQUENCE - Enum constant in enum class org.jline.shell.Pipeline.Operator

Sequence: execute next command unconditionally (;)

session() - Method in class org.jline.shell.impl.DefaultCommandDispatcher

Returns the command session used by this dispatcher.

setAlias(String, String) - Method in interface org.jline.shell.AliasManager

Defines or redefines an alias.

setAlias(String, String) - Method in class org.jline.shell.impl.DefaultAliasManager

setDescriptionCache(boolean) - Method in class org.jline.shell.widget.CommandTailTipWidgets

Sets whether resolved descriptions should be cached permanently.

setDescriptions(Map<String, CommandDescription>) - Method in class org.jline.shell.widget.CommandTailTipWidgets

Replaces the description map with a new set of command descriptions.

setDescriptionSize(int) - Method in class org.jline.shell.widget.CommandTailTipWidgets

Sets the status bar size.

setErr(PrintStream) - Method in class org.jline.shell.CommandSession

Sets the error stream.

setErrorIndex(int) - Method in class org.jline.shell.impl.CommandHighlighter

setErrorPattern(Pattern) - Method in class org.jline.shell.impl.CommandHighlighter

setForegroundJob(Job) - Method in class org.jline.shell.CommandSession

Sets the current foreground job.

setIn(InputStream) - Method in class org.jline.shell.CommandSession

Sets the input stream.

setLastExitCode(int) - Method in class org.jline.shell.CommandSession

Sets the exit code of the last executed command.

setOut(PrintStream) - Method in class org.jline.shell.CommandSession

Sets the output stream.

setStatus(Job.Status) - Method in class org.jline.shell.impl.DefaultJob

Sets the status of this job.

setSyntaxHighlighter(Function<AttributedString, AttributedString>) - Method in class org.jline.shell.widget.CommandTailTipWidgets

Sets a function to highlight syntax in description text.

setTipType(CommandTailTipWidgets.TipType) - Method in class org.jline.shell.widget.CommandTailTipWidgets

Sets the tip type.

setWorkingDirectory(Path) - Method in class org.jline.shell.CommandSession

Sets the working directory.

Shell - Class in org.jline.shell

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

ShellBuilder - Class in org.jline.shell

Builder for creating Shell instances.

SimpleCommandGroup - Class in org.jline.shell.impl

Default implementation of CommandGroup backed by a list of commands.

SimpleCommandGroup(String, Collection<Command>) - Constructor for class org.jline.shell.impl.SimpleCommandGroup

Creates a new command group with the given name and commands.

SimpleCommandGroup(String, Command...) - Constructor for class org.jline.shell.impl.SimpleCommandGroup

Creates a new command group with the given name and commands.

source() - Method in class org.jline.shell.impl.DefaultPipeline

source() - Method in interface org.jline.shell.Pipeline

Returns the original command line string that was parsed to create this pipeline.

stages() - Method in class org.jline.shell.impl.DefaultPipeline

stages() - Method in interface org.jline.shell.Pipeline

Returns the ordered list of stages in this pipeline.

status() - Method in class org.jline.shell.impl.DefaultJob

status() - Method in interface org.jline.shell.Job

Returns the current status of this job.

STDERR_REDIRECT - Enum constant in enum class org.jline.shell.Pipeline.Operator

Stderr redirection: redirect stderr to file (2>)

stderrRedirect(Path) - Method in class org.jline.shell.PipelineBuilder

Adds a stderr redirection (2>) to the specified file.

stop() - Method in class org.jline.shell.Shell

Stops the REPL loop.

subcommand(boolean) - Method in class org.jline.shell.CommandDescription.Builder

Sets whether this description represents a subcommand.

subcommands() - Method in interface org.jline.shell.Command

Returns the subcommands of this command.

suspend() - Method in class org.jline.shell.impl.DefaultJob

suspend() - Method in interface org.jline.shell.Job

Suspends this job.

Suspended - Enum constant in enum class org.jline.shell.Job.Status

Job has been suspended (e.g., via Ctrl-Z)

symbol() - Method in enum class org.jline.shell.Pipeline.Operator

Returns the string symbol for this operator.

SYNTAX - Enum constant in enum class org.jline.shell.CommandLine.Type

Syntax description

T

tail() - Method in class org.jline.shell.CommandLine

Returns the part after the cursor.

TAIL_TIP - Enum constant in enum class org.jline.shell.widget.CommandTailTipWidgets.TipType

Show positional argument descriptions as tail-tips.

tailtipAcceptLine() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipBackwardDelete() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipComplete() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipDelete() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipInsert() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipKillLine() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipKillWholeLine() - Method in class org.jline.shell.widget.CommandTailTipWidgets

tailtipUpdateStatus() - Method in class org.jline.shell.widget.CommandTailTipWidgets

terminal() - Method in interface org.jline.shell.CommandDispatcher

Returns the terminal associated with this dispatcher.

terminal() - Method in class org.jline.shell.CommandSession

Returns the terminal for this session.

terminal() - Method in class org.jline.shell.impl.DefaultCommandDispatcher

terminal() - Method in class org.jline.shell.Shell

Returns the terminal used by this shell.

terminal(Terminal) - Method in class org.jline.shell.ShellBuilder

Sets the terminal for the shell.

thread() - Method in class org.jline.shell.impl.DefaultJob

Returns the thread executing this job.

tipType() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Returns the current tip type.

toggle() - Method in class org.jline.shell.widget.AutopairWidgets

Toggles auto-pairing on or off.

toggleKeyBindings() - Method in class org.jline.shell.widget.AutopairWidgets

toggleKeyBindings() - Method in class org.jline.shell.widget.CommandTailTipWidgets

toggleWindow() - Method in class org.jline.shell.widget.CommandTailTipWidgets

Token(String, boolean) - Constructor for class org.jline.shell.impl.PipelineParser.Token

Creates a new token.

toString() - Method in class org.jline.shell.impl.DefaultPipeline.DefaultStage

toString() - Method in class org.jline.shell.impl.DefaultPipeline

trace(Throwable) - Method in interface org.jline.shell.CommandDispatcher

Traces an exception (e.g., prints it to the terminal).

type() - Method in class org.jline.shell.CommandLine

Returns the description type.

U

UnknownCommandException - Exception Class in org.jline.shell

This exception is thrown by an CommandDispatcher when it failed to find a requested command.

UnknownCommandException(String) - Constructor for exception class org.jline.shell.UnknownCommandException

V

valid(boolean) - Method in class org.jline.shell.CommandDescription.Builder

Sets whether this description is valid.

value - Variable in class org.jline.shell.impl.PipelineParser.Token

The token value.

valueOf(String) - Static method in enum class org.jline.shell.CommandLine.Type

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.jline.shell.Job.Status

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.jline.shell.Pipeline.Operator

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class org.jline.shell.widget.CommandTailTipWidgets.TipType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.jline.shell.CommandLine.Type

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.jline.shell.Job.Status

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.jline.shell.Pipeline.Operator

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class org.jline.shell.widget.CommandTailTipWidgets.TipType

Returns an array containing the constants of this enum class, in the order they are declared.

variable(String, Object) - Method in class org.jline.shell.ShellBuilder

Sets a LineReader variable.

variableCommands(boolean) - Method in class org.jline.shell.ShellBuilder

Enables or disables built-in variable commands (set, unset, export).

VariableCommands - Class in org.jline.shell.impl

Built-in commands for managing session variables: set, unset, and export.

VariableCommands() - Constructor for class org.jline.shell.impl.VariableCommands

Creates a new VariableCommands group.

variables() - Method in class org.jline.shell.CommandSession

Returns all session variables.

W

workingDirectory() - Method in class org.jline.shell.CommandSession

Returns the working directory.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form