Package 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 registries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SystemRegistryImpl.ArgsParser
protected static class	SystemRegistryImpl.CommandData
private static class	SystemRegistryImpl.CommandOutputStream
private class	SystemRegistryImpl.NamesAndValues
static enum	SystemRegistryImpl.Pipe
private static class	SystemRegistryImpl.PipelineCompleter
private static class	SystemRegistryImpl.ScriptStore
static class	SystemRegistryImpl.UnknownCommandException

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

CommandRegistry.CommandSession

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

SystemRegistry.Registeries

Field Summary

Fields

Modifier and Type	Field	Description
private static final Class<?>[]	BUILTIN_REGISTRIES
private final Map<String,CommandMethods>	commandExecute
private boolean	commandGroups
private final Map<String,List<String>>	commandInfos
private CommandRegistry[]	commandRegistries
protected final ConfigurationPath	configPath
private Integer	consoleId
private final AggregateCompleter	customAggregateCompleter
private final SystemCompleter	customSystemCompleter
private Exception	exception
private SystemRegistryImpl.NamesAndValues	names
private final SystemRegistryImpl.CommandOutputStream	outputStream
protected final Parser	parser
private final Map<SystemRegistryImpl.Pipe,String>	pipeName
private Function<CmdLine,CmdDesc>	scriptDescription
private SystemRegistryImpl.ScriptStore	scriptStore
private final Map<String,CommandRegistry>	subcommands
protected final Supplier<Path>	workDir

Constructor Summary

Constructors

Constructor	Description
SystemRegistryImpl(Parser parser, Terminal terminal, Supplier<Path> workDir, ConfigurationPath configPath)

Method Summary

Modifier and Type	Method	Description
private SystemCompleter	_compileCompleters()
void	addCompleter(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(List<String> args)	Returns a command description for use in the JLine Widgets framework.
CmdDesc	commandDescription(CmdLine line)	Returns a command, method or syntax description for use in the JLine Widgets framework.
private CmdDesc	commandDescription(CommandRegistry subreg)
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.
private List<Completers.OptDesc>	commandOptions(String command)
private CommandRegistry.CommandSession	commandSession()
private List<SystemRegistryImpl.CommandData>	compileCommandLine(String commandLine)
SystemCompleter	compileCompleters()	Returns a SystemCompleter that can provide detailed completion information for all registered commands.
Completer	completer()	Returns command completer that includes also console variable and script completion.
ConsoleEngine	consoleEngine()
Object	consoleOption(String name)	Return console option value
<T> T	consoleOption(String name, T defVal)	Return console option value
private String	doCommandInfo(List<String> info)
private List<Completer>	emptyCompleter(String command)
Object	execute(String line)	Execute a command, script or evaluate scriptEngine statement
private Object	execute(String command, String rawLine, String[] args)
private Object	exit(CommandInput input)
private List<Completer>	exitCompleter(String command)
private String	flipArgument(String command, String subLine, List<String> pipes, List<String> arglist)
Collection<String>	getPipeNames()
SystemRegistryImpl	groupCommandsInHelp(boolean commandGroups)
boolean	hasCommand(String command)	Returns whether a command with the specified name is known to this registry.
private Object	help(CommandInput input)
private List<Completer>	helpCompleter(String command)
private void	helpTopic(List<String> topics, boolean commandGroups, boolean info)
void	initialize(File script)	Initialize consoleEngine environment by executing console script
Object	invoke(String command, Object... args)	Execute command with arguments
private boolean	isBuiltinRegistry(CommandRegistry registry)
boolean	isCommandAlias(String command)	Returns whether alias is known command alias.
boolean	isCommandOrScript(String command)	Returns whether command is known to this registry.
boolean	isCommandOrScript(ParsedLine line)	Returns whether a line contains command/script that is known to this registry.
private boolean	isInTopics(List<String> args, String name)
private boolean	isLocalCommand(String command)
private CmdDesc	localCommandDescription(String command)
private List<String>	localCommandInfo(String command)
private Set<String>	localCommandNames()
private Object	localExecute(String command, Object[] args)
private Options	parseOptions(String[] usage, Object[] args)
private ConsoleEngine.ExecutionResult	postProcess(SystemRegistryImpl.CommandData cmd, boolean statement, ConsoleEngine consoleEngine, Object result)
private void	printCommandInfo(String command, String info, int max)
private void	printCommands(Collection<String> commands, int max)
private void	printHeader(String header)
private File	redirectFile(String name)
void	register(String command, CommandRegistry subcommandRegistry)	Register subcommand registry
private void	registryHelp(CommandRegistry registry)
private int	registryId(String command)
private List<String>	registryNames()
void	rename(SystemRegistryImpl.Pipe pipe, String name)
private String	replaceCommandAlias(String variable, String command, String rawLine)
private String	replacePipeAlias(SystemRegistryImpl.ArgsParser ap, String pipeAlias, List<String> args, Map<String,List<String>> customPipes)
private void	replacePipeAliases(ConsoleEngine consoleEngine, Map<String,List<String>> customPipes, SystemRegistryImpl.ArgsParser ap)
void	setCommandRegistries(CommandRegistry... commandRegistries)	Set command registries
void	setConsoleOption(String name, Object value)	Set console option value
void	setGroupCommandsInHelp(boolean commandGroups)
void	setScriptDescription(Function<CmdLine,CmdDesc> scriptDescription)
private Object	subcommand(CommandInput input)
Terminal	terminal()
void	trace(boolean stack, Throwable exception)	Print exception on terminal
void	trace(Throwable exception)	Print exception on terminal
private void	trace(SystemRegistryImpl.CommandData commandData)

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.CommandRegistry

invoke, name

Field Details

BUILTIN_REGISTRIES

private static final Class<?>[] BUILTIN_REGISTRIES

commandRegistries

private CommandRegistry[] commandRegistries

consoleId

private Integer consoleId

parser

protected final Parser parser

configPath

protected final ConfigurationPath configPath

workDir

protected final Supplier<Path> workDir

subcommands

private final Map<String,CommandRegistry> subcommands

pipeName

private final Map<SystemRegistryImpl.Pipe,String> pipeName

commandExecute

private final Map<String,CommandMethods> commandExecute

commandInfos

private final Map<String,List<String>> commandInfos

exception

private Exception exception

outputStream

private final SystemRegistryImpl.CommandOutputStream outputStream

scriptStore

private SystemRegistryImpl.ScriptStore scriptStore

names

private SystemRegistryImpl.NamesAndValues names

customSystemCompleter

private final SystemCompleter customSystemCompleter

customAggregateCompleter

private final AggregateCompleter customAggregateCompleter

commandGroups

private boolean commandGroups

scriptDescription

private Function<CmdLine,CmdDesc> scriptDescription

Constructor Details

SystemRegistryImpl

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

Method Details

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 registries

Specified by:

setCommandRegistries in interface SystemRegistry

Parameters:

commandRegistries - command registries 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

localCommandNames

private Set<String> localCommandNames()

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

consoleOption

public <T> T consoleOption(String name,
 T defVal)

Description copied from interface: SystemRegistry

Return console option value

Specified by:

consoleOption in interface ConsoleOptionGetter

Specified by:

consoleOption in interface SystemRegistry

Type Parameters:

T - option type

Parameters:

name - the option name

defVal - value to return if console option does not exists

Returns:

option value

setConsoleOption

public void setConsoleOption(String name,
 Object value)

Description copied from interface: SystemRegistry

Set console option value

Specified by:

setConsoleOption in interface SystemRegistry

Parameters:

name - the option name

value - value to assign console option

register

public void register(String command,
 CommandRegistry subcommandRegistry)

Register subcommand registry

Specified by:

register in interface SystemRegistry

Parameters:

command - main command

subcommandRegistry - subcommand registry

localCommandInfo

private List<String> localCommandInfo(String command)

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)

isLocalCommand

private boolean isLocalCommand(String command)

isCommandOrScript

public boolean isCommandOrScript(ParsedLine line)

Description copied from interface: SystemRegistry

Returns whether a line contains command/script that is known to this registry.

Specified by:

isCommandOrScript in interface SystemRegistry

Parameters:

line - the parsed command line to test

Returns:

true if the specified line has a command registered

isCommandOrScript

public boolean isCommandOrScript(String command)

Description copied from interface: SystemRegistry

Returns whether command is known to this registry.

Specified by:

isCommandOrScript in interface SystemRegistry

Parameters:

command - the command to test

Returns:

true if the specified command is known

addCompleter

public void addCompleter(Completer completer)

compileCompleters

public 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

_compileCompleters

private SystemCompleter _compileCompleters()

completer

public 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

localCommandDescription

private CmdDesc localCommandDescription(String command)

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.

commandDescription

private CmdDesc commandDescription(CommandRegistry subreg)

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

localExecute

private Object localExecute(String command,
 Object[] args)
                     throws Exception

Throws:

Exception

terminal

public Terminal terminal()

Specified by:

terminal in interface SystemRegistry

Returns:

terminal

commandSession

private CommandRegistry.CommandSession commandSession()

isCommandAlias

public boolean isCommandAlias(String command)

Description copied from interface: SystemRegistry

Returns whether alias is known command alias.

Specified by:

isCommandAlias in interface SystemRegistry

Parameters:

command - the alias to test

Returns:

true if the alias is known command alias

replaceCommandAlias

private String replaceCommandAlias(String variable,
 String command,
 String rawLine)

replacePipeAlias

private String replacePipeAlias(SystemRegistryImpl.ArgsParser ap,
 String pipeAlias,
 List<String> args,
 Map<String,List<String>> customPipes)

replacePipeAliases

private void replacePipeAliases(ConsoleEngine consoleEngine,
 Map<String,List<String>> customPipes,
 SystemRegistryImpl.ArgsParser ap)

compileCommandLine

private List<SystemRegistryImpl.CommandData> compileCommandLine(String commandLine)

redirectFile

private File redirectFile(String name)

flipArgument

private String flipArgument(String command,
 String subLine,
 List<String> pipes,
 List<String> arglist)

execute

private Object execute(String command,
 String rawLine,
 String[] args)
                throws Exception

Throws:

Exception

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

postProcess

private ConsoleEngine.ExecutionResult postProcess(SystemRegistryImpl.CommandData cmd,
 boolean statement,
 ConsoleEngine consoleEngine,
 Object result)

cleanUp

public void cleanUp()

Description copied from interface: SystemRegistry

Delete temporary console variables and reset output streams

Specified by:

cleanUp in interface SystemRegistry

trace

private void trace(SystemRegistryImpl.CommandData commandData)

trace

public void trace(Throwable 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,
 Throwable 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

consoleEngine

public ConsoleEngine consoleEngine()

isBuiltinRegistry

private boolean isBuiltinRegistry(CommandRegistry registry)

printHeader

private void printHeader(String header)

printCommandInfo

private void printCommandInfo(String command,
 String info,
 int max)

printCommands

private void printCommands(Collection<String> commands,
 int max)

doCommandInfo

private String doCommandInfo(List<String> info)

isInTopics

private boolean isInTopics(List<String> args,
 String name)

parseOptions

private Options parseOptions(String[] usage,
 Object[] args)
                      throws Options.HelpException

Throws:

Options.HelpException

help

private Object help(CommandInput input)

helpTopic

private void helpTopic(List<String> topics,
 boolean commandGroups,
 boolean info)

exit

private Object exit(CommandInput input)

registryHelp

private void registryHelp(CommandRegistry registry)
                   throws Exception

Throws:

Exception

subcommand

private Object subcommand(CommandInput input)

commandOptions

private List<Completers.OptDesc> commandOptions(String command)

registryNames

private List<String> registryNames()

emptyCompleter

private List<Completer> emptyCompleter(String command)

helpCompleter

private List<Completer> helpCompleter(String command)

exitCompleter

private List<Completer> exitCompleter(String command)

registryId

private int registryId(String command)