SystemRegistryImpl (JLine Builtins 3.15.0 API)

java.lang.Object
- org.jline.builtins.SystemRegistryImpl

All Implemented Interfaces:

SystemRegistry, CommandRegistry
```
public class SystemRegistryImpl
extends Object
implements SystemRegistry
```
Aggregate command registeries.

Author:

Matti Rinta-Nikkola

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected static class SystemRegistryImpl.CommandData

static class SystemRegistryImpl.Pipe
- Nested classes/interfaces inherited from interface org.jline.console.CommandRegistry
  CommandRegistry.CommandSession
- Nested classes/interfaces inherited from interface org.jline.builtins.SystemRegistry
  SystemRegistry.Registeries

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCompleter(Completer completer)`
`void`	`cleanUp()`	Delete temporary console variables and reset output streams
`void`	`close()`	Orderly close SystemRegistry.
`Map<String,String>`	`commandAliases()`
`CmdDesc`	`commandDescription(String command)`
`CmdDesc`	`commandDescription(List<String> args)`
`CmdDesc`	`commandDescription(Widgets.CmdLine line)`	Returns a command, method or syntax description for use in the JLine Widgets framework.
`List<String>`	`commandInfo(String command)`
`Set<String>`	`commandNames()`
`SystemCompleter`	`compileCompleters()`
`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
`Object`	`execute(String command, String[] args)`	Execute command with arguments
`Collection<String>`	`getPipeNames()`
`boolean`	`hasCommand(String command)`
`void`	`initialize(File script)`	Initialize consoleEngine environment by executing console script
`Object`	`invoke(String command, Object... args)`	Execute command with arguments
`Object`	`localExecute(String command, Object[] args)`
`void`	`register(String command, CommandRegistry subcommandRegistry)`	Register subcommand registry
`void`	`rename(SystemRegistryImpl.Pipe pipe, String name)`
`void`	`setCommandRegistries(CommandRegistry... commandRegistries)`	Set command registeries
`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.CommandRegistry
execute, invoke, name

- Constructor Detail
  - SystemRegistryImpl
```
public SystemRegistryImpl(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()
```
    Specified by:
    
    commandNames in interface CommandRegistry
  - commandAliases
```
public Map<String,String> commandAliases()
```
    Specified by:
    
    commandAliases in interface CommandRegistry
  - consoleOption
```
public Object consoleOption(String name)
```
    Description copied from interface: SystemRegistry
    
    Return console option value
    
    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)
```
    Specified by:
    
    commandInfo in interface CommandRegistry
  - hasCommand
```
public boolean hasCommand(String command)
```
    Specified by:
    
    hasCommand in interface CommandRegistry
  - addCompleter
```
public void addCompleter(Completer completer)
```
  - compileCompleters
```
public SystemCompleter compileCompleters()
```
    Specified by:
    
    compileCompleters in interface CommandRegistry
  - 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
  - commandDescription
```
public CmdDesc commandDescription(String command)
```
    Specified by:
    
    commandDescription in interface CommandRegistry
  - commandDescription
```
public CmdDesc commandDescription(List<String> args)
```
    Specified by:
    
    commandDescription in interface CommandRegistry
  - commandDescription
```
public CmdDesc commandDescription(Widgets.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
  - execute
```
public Object execute(String command,
                      String[] args)
               throws Exception
```
    Description copied from interface: SystemRegistry
    
    Execute command with arguments
    
    Specified by:
    
    execute 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
```
public Object localExecute(String command,
                           Object[] args)
                    throws Exception
```
    Throws:
    
    Exception
  - 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

Class SystemRegistryImpl

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jline.console.CommandRegistry

Constructor Detail

SystemRegistryImpl

Method Detail

rename

getPipeNames

setCommandRegistries

initialize

commandNames

commandAliases

consoleOption

register

commandInfo

hasCommand

addCompleter

compileCompleters

completer

commandDescription

commandDescription

commandDescription

invoke

execute

localExecute

terminal

execute

cleanUp

trace

trace

close