org.jline.console.impl

Class SystemRegistryImpl

java.lang.Object

org.jline.console.impl.SystemRegistryImpl

All Implemented Interfaces:

ConsoleOptionGetter, CommandRegistry, SystemRegistry

public class SystemRegistryImpl
extends Object
implements SystemRegistry

Aggregate command registeries.

Author:

Matti Rinta-Nikkola

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SystemRegistryImpl.CommandData
static class	SystemRegistryImpl.Pipe

Nested classes/interfaces inherited from interface org.jline.console.SystemRegistry

SystemRegistry.Registeries

Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry

CommandRegistry.CommandSession

Constructor Summary

Constructors

Constructor and Description
SystemRegistryImpl(org.jline.reader.Parser parser, org.jline.terminal.Terminal terminal, Supplier<Path> workDir, ConfigurationPath configPath)

Method Summary

Modifier and Type	Method and Description
void	addCompleter(org.jline.reader.Completer completer)
void	cleanUp() Delete temporary console variables and reset output streams
void	close() Orderly close SystemRegistry.
Map<String,String>	commandAliases() Returns a map of alias-to-command names known by this registry.
CmdDesc	commandDescription(CmdLine line) Returns a command, method or syntax description for use in the JLine Widgets framework.
CmdDesc	commandDescription(List<String> args) Returns a command description for use in the JLine Widgets framework.
List<String>	commandInfo(String command) Returns a short info about command known by this registry.
Set<String>	commandNames() Returns the command names known by this registry.
org.jline.reader.impl.completer.SystemCompleter	compileCompleters() Returns a SystemCompleter that can provide detailed completion information for all registered commands.
org.jline.reader.Completer	completer() Returns command completer that includes also console variable and script completion.
Object	consoleOption(String name) Return console option value
Object	execute(String line) Execute a command, script or evaluate scriptEngine statement
Collection<String>	getPipeNames()
SystemRegistryImpl	groupCommandsInHelp(boolean commandGroups)
boolean	hasCommand(String command) Returns whether a command with the specified name is known to this registry.
void	initialize(File script) Initialize consoleEngine environment by executing console script
Object	invoke(String command, Object... args) Execute command with arguments
void	register(String command, CommandRegistry subcommandRegistry) Register subcommand registry
void	rename(SystemRegistryImpl.Pipe pipe, String name)
void	setCommandRegistries(CommandRegistry... commandRegistries) Set command registeries
void	setGroupCommandsInHelp(boolean commandGroups)
void	setScriptDescription(Function<CmdLine,CmdDesc> scriptDescription)
org.jline.terminal.Terminal	terminal()
void	trace(boolean stack, Exception exception) Print exception on terminal
void	trace(Exception exception) Print exception on terminal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.console.SystemRegistry

add, get, remove

Methods inherited from interface org.jline.console.CommandRegistry

aggregateCompleters, compileCompleters, invoke, name

Constructor Detail

SystemRegistryImpl

public SystemRegistryImpl(org.jline.reader.Parser parser,
                          org.jline.terminal.Terminal terminal,
                          Supplier<Path> workDir,
                          ConfigurationPath configPath)

Method Detail

rename

public void rename(SystemRegistryImpl.Pipe pipe,
                   String name)

getPipeNames

public Collection<String> getPipeNames()

Specified by:

getPipeNames in interface SystemRegistry

Returns:

pipe names defined in systemRegistry

setCommandRegistries

public void setCommandRegistries(CommandRegistry... commandRegistries)

Description copied from interface: SystemRegistry

Set command registeries

Specified by:

setCommandRegistries in interface SystemRegistry

Parameters:

commandRegistries - command registeries used by the application

initialize

public void initialize(File script)

Description copied from interface: SystemRegistry

Initialize consoleEngine environment by executing console script

Specified by:

initialize in interface SystemRegistry

Parameters:

script - initialization script

commandNames

public Set<String> commandNames()

Description copied from interface: CommandRegistry

Returns the command names known by this registry.

Specified by:

commandNames in interface CommandRegistry

Returns:

the set of known command names, excluding aliases

commandAliases

public Map<String,String> commandAliases()

Description copied from interface: CommandRegistry

Returns a map of alias-to-command names known by this registry.

Specified by:

commandAliases in interface CommandRegistry

Returns:

a map with alias keys and command name values

consoleOption

public Object consoleOption(String name)

Description copied from interface: SystemRegistry

Return console option value

Specified by:

consoleOption in interface ConsoleOptionGetter

Specified by:

consoleOption in interface SystemRegistry

Parameters:

name - the option name

Returns:

option value

register

public void register(String command,
                     CommandRegistry subcommandRegistry)

Register subcommand registry

Specified by:

register in interface SystemRegistry

Parameters:

command - main command

subcommandRegistry - subcommand registry

commandInfo

public List<String> commandInfo(String command)

Description copied from interface: CommandRegistry

Returns a short info about command known by this registry.

Specified by:

commandInfo in interface CommandRegistry

Parameters:

command - the command name

Returns:

a short info about command

hasCommand

public boolean hasCommand(String command)

Description copied from interface: CommandRegistry

Returns whether a command with the specified name is known to this registry.

Specified by:

hasCommand in interface CommandRegistry

Parameters:

command - the command name to test

Returns:

true if the specified command is registered

setGroupCommandsInHelp

public void setGroupCommandsInHelp(boolean commandGroups)

groupCommandsInHelp

public SystemRegistryImpl groupCommandsInHelp(boolean commandGroups)

addCompleter

public void addCompleter(org.jline.reader.Completer completer)

compileCompleters

public org.jline.reader.impl.completer.SystemCompleter compileCompleters()

Description copied from interface: CommandRegistry

Returns a SystemCompleter that can provide detailed completion information for all registered commands.

Specified by:

compileCompleters in interface CommandRegistry

Returns:

a SystemCompleter that can provide command completion for all registered commands

completer

public org.jline.reader.Completer completer()

Description copied from interface: SystemRegistry

Returns command completer that includes also console variable and script completion.

Specified by:

completer in interface SystemRegistry

Returns:

command completer

commandDescription

public CmdDesc commandDescription(List<String> args)

Description copied from interface: CommandRegistry

Returns a command description for use in the JLine Widgets framework. Default method must be overridden to return sub command descriptions.

Specified by:

commandDescription in interface CommandRegistry

Parameters:

args - command (args[0]) and its arguments

Returns:

command description for JLine TailTipWidgets to be displayed in the terminal status bar.

setScriptDescription

public void setScriptDescription(Function<CmdLine,CmdDesc> scriptDescription)

commandDescription

public CmdDesc commandDescription(CmdLine line)

Description copied from interface: SystemRegistry

Returns a command, method or syntax description for use in the JLine Widgets framework.

Specified by:

commandDescription in interface SystemRegistry

Parameters:

line - command line whose description to return

Returns:

command description for JLine TailTipWidgets to be displayed in the terminal status bar.

invoke

public Object invoke(String command,
                     Object... args)
              throws Exception

Description copied from interface: SystemRegistry

Execute command with arguments

Specified by:

invoke in interface SystemRegistry

Parameters:

command - command to be executed

args - arguments of the command

Returns:

command execution result

Throws:

Exception - in case of error

terminal

public org.jline.terminal.Terminal terminal()

Specified by:

terminal in interface SystemRegistry

Returns:

terminal

execute

public Object execute(String line)
               throws Exception

Description copied from interface: SystemRegistry

Execute a command, script or evaluate scriptEngine statement

Specified by:

execute in interface SystemRegistry

Parameters:

line - command line to be executed

Returns:

execution result

Throws:

Exception - in case of error

cleanUp

public void cleanUp()

Description copied from interface: SystemRegistry

Delete temporary console variables and reset output streams

Specified by:

cleanUp in interface SystemRegistry

trace

public void trace(Exception exception)

Description copied from interface: SystemRegistry

Print exception on terminal

Specified by:

trace in interface SystemRegistry

Parameters:

exception - exception to print on terminal

trace

public void trace(boolean stack,
                  Exception exception)

Description copied from interface: SystemRegistry

Print exception on terminal

Specified by:

trace in interface SystemRegistry

Parameters:

stack - print stack trace if stack true otherwise message

exception - exception to be printed

close

public void close()

Description copied from interface: SystemRegistry

Orderly close SystemRegistry.

Specified by:

close in interface SystemRegistry