Package org.jline.console.impl
Class ConsoleEngineImpl
java.lang.Object
org.jline.console.impl.AbstractCommandRegistry
org.jline.console.impl.JlineCommandRegistry
org.jline.console.impl.ConsoleEngineImpl
- All Implemented Interfaces:
CommandRegistry
,ConsoleEngine
Manage console variables, commands and script execution.
- Author:
- Matti Rinta-Nikkola
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.jline.console.CommandRegistry
CommandRegistry.CommandSession
Nested classes/interfaces inherited from interface org.jline.console.ConsoleEngine
ConsoleEngine.ExecutionResult, ConsoleEngine.WidgetCreator
-
Field Summary
Fields inherited from interface org.jline.console.ConsoleEngine
VAR_NANORC
-
Constructor Summary
ConstructorsConstructorDescriptionConsoleEngineImpl
(Set<ConsoleEngineImpl.Command> commands, ScriptEngine engine, Printer printer, Supplier<Path> workDir, ConfigurationPath configPath) ConsoleEngineImpl
(ScriptEngine engine, Printer printer, Supplier<Path> workDir, ConfigurationPath configPath) -
Method Summary
Modifier and TypeMethodDescription<T> T
consoleOption
(String option, T defval) Read console option valueExecutes either JLine or ScriptEngine script.Executes command line that does not contain known command by the system registry.boolean
executeWidget
(Object function) Execute widget functionexpandCommandLine
(String line) Substitutes command line with system registry invoke method call.Object[]
expandParameters
(String[] args) Substituting args references with their values.expandToList
(List<String> params) Expands parameter list to stringReturns alias 'name' valueReturns named pipe namesgetPipes()
Returns defined pipesgetVariable
(String name) Get variable valueboolean
Returns true if alias 'name' existsboolean
hasVariable
(String name) Test if variable with name existsinvoke
(CommandRegistry.CommandSession session, String command, Object... args) Execute a command.boolean
Checks if consoleEngine is executing scriptvoid
Persist object to filepostProcess
(Object result) Post processes execution result.postProcess
(String line, Object result, String output) Post processes execution result.void
Print object.void
purge()
Delete temporary console variablesvoid
putVariable
(String name, Object value) Create console variableReturns script and variable completersscripts()
Returns all scripts found from PATHvoid
setConsoleOption
(String name, Object value) Set console option valuevoid
setLineReader
(LineReader reader) Sets lineReadervoid
setScriptExtension
(String extension) Sets file name extension used by console scriptsvoid
setSystemRegistry
(SystemRegistry systemRegistry) Sets systemRegistryRead object from filevoid
Print object if trace is enabledMethods inherited from class org.jline.console.impl.JlineCommandRegistry
commandDescription, commandInfo, commandOptions, compileCommandDescription, compileCommandInfo, compileCommandOptions, defaultCompleter, parseOptions
Methods inherited from class org.jline.console.impl.AbstractCommandRegistry
alias, commandAliases, commandNames, compileCompleters, doHelpDesc, getCommandMethods, hasCommand, registerCommands, registerCommands, registeredCommand, rename, saveException
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
commandAliases, commandDescription, commandInfo, commandNames, compileCompleters, hasCommand, name
Methods inherited from interface org.jline.console.ConsoleEngine
execute
-
Constructor Details
-
ConsoleEngineImpl
public ConsoleEngineImpl(ScriptEngine engine, Printer printer, Supplier<Path> workDir, ConfigurationPath configPath) throws IOException - Throws:
IOException
-
ConsoleEngineImpl
public ConsoleEngineImpl(Set<ConsoleEngineImpl.Command> commands, ScriptEngine engine, Printer printer, Supplier<Path> workDir, ConfigurationPath configPath) throws IOException - Throws:
IOException
-
-
Method Details
-
setLineReader
Description copied from interface:ConsoleEngine
Sets lineReader- Specified by:
setLineReader
in interfaceConsoleEngine
- Parameters:
reader
- LineReader
-
isExecuting
public boolean isExecuting()Description copied from interface:ConsoleEngine
Checks if consoleEngine is executing script- Specified by:
isExecuting
in interfaceConsoleEngine
- Returns:
- true when executing script
-
setSystemRegistry
Description copied from interface:ConsoleEngine
Sets systemRegistry- Specified by:
setSystemRegistry
in interfaceConsoleEngine
- Parameters:
systemRegistry
- SystemRegistry
-
setScriptExtension
Description copied from interface:ConsoleEngine
Sets file name extension used by console scripts- Specified by:
setScriptExtension
in interfaceConsoleEngine
- Parameters:
extension
- console script file extension
-
hasAlias
Description copied from interface:ConsoleEngine
Returns true if alias 'name' exists- Specified by:
hasAlias
in interfaceConsoleEngine
- Parameters:
name
- alias name- Returns:
- true if alias exists
-
getAlias
Description copied from interface:ConsoleEngine
Returns alias 'name' value- Specified by:
getAlias
in interfaceConsoleEngine
- Parameters:
name
- alias name- Returns:
- value of alias
-
getPipes
Description copied from interface:ConsoleEngine
Returns defined pipes- Specified by:
getPipes
in interfaceConsoleEngine
- Returns:
- map of defined pipes
-
getNamedPipes
Description copied from interface:ConsoleEngine
Returns named pipe names- Specified by:
getNamedPipes
in interfaceConsoleEngine
- Returns:
- list of named pipe names
-
scriptCompleters
Description copied from interface:ConsoleEngine
Returns script and variable completers- Specified by:
scriptCompleters
in interfaceConsoleEngine
- Returns:
- script and variable completers
-
scripts
Description copied from interface:ConsoleEngine
Returns all scripts found from PATH- Specified by:
scripts
in interfaceConsoleEngine
- Returns:
- map keys have script file names and value is true if it is console script
-
expandParameters
Description copied from interface:ConsoleEngine
Substituting args references with their values.- Specified by:
expandParameters
in interfaceConsoleEngine
- Parameters:
args
- the arguments to be expanded- Returns:
- expanded arguments
- Throws:
Exception
- in case of error
-
expandToList
Description copied from interface:ConsoleEngine
Expands parameter list to string- Specified by:
expandToList
in interfaceConsoleEngine
- Parameters:
params
- list of script parameters- Returns:
- expanded parameters list
-
execute
Description copied from interface:ConsoleEngine
Executes either JLine or ScriptEngine script.- Specified by:
execute
in interfaceConsoleEngine
- Parameters:
script
- script filecmdLine
- raw command lineargs
- script arguments- Returns:
- script execution result
- Throws:
Exception
- in case of error
-
expandCommandLine
Description copied from interface:ConsoleEngine
Substitutes command line with system registry invoke method call.- Specified by:
expandCommandLine
in interfaceConsoleEngine
- Parameters:
line
- command line to be expanded- Returns:
- expanded command line
-
execute
Description copied from interface:ConsoleEngine
Executes command line that does not contain known command by the system registry. If the line is neither JLine or ScriptEngine script it will be evaluated as ScriptEngine statement.- Specified by:
execute
in interfaceConsoleEngine
- Parameters:
cmd
- parsed command/script nameline
- raw command lineargs
- parsed arguments of the command- Returns:
- command line execution result
- Throws:
Exception
- in case of error
-
purge
public void purge()Description copied from interface:ConsoleEngine
Delete temporary console variables- Specified by:
purge
in interfaceConsoleEngine
-
putVariable
Description copied from interface:ConsoleEngine
Create console variable- Specified by:
putVariable
in interfaceConsoleEngine
- Parameters:
name
- name of the variablevalue
- value of the variable
-
getVariable
Description copied from interface:ConsoleEngine
Get variable value- Specified by:
getVariable
in interfaceConsoleEngine
- Parameters:
name
- name of the variable- Returns:
- variable value
-
hasVariable
Description copied from interface:ConsoleEngine
Test if variable with name exists- Specified by:
hasVariable
in interfaceConsoleEngine
- Parameters:
name
- name of the variable- Returns:
- true if variable with name exists
-
executeWidget
Description copied from interface:ConsoleEngine
Execute widget function- Specified by:
executeWidget
in interfaceConsoleEngine
- Parameters:
function
- to execute- Returns:
- true on success
-
consoleOption
Description copied from interface:ConsoleEngine
Read console option value- Specified by:
consoleOption
in interfaceConsoleEngine
- Type Parameters:
T
- option type- Parameters:
option
- option namedefval
- default value- Returns:
- option value
-
setConsoleOption
Description copied from interface:ConsoleEngine
Set console option value- Specified by:
setConsoleOption
in interfaceConsoleEngine
- Parameters:
name
- the option namevalue
- value to assign console option
-
postProcess
Description copied from interface:ConsoleEngine
Post processes execution result. If result is to be assigned to the console variable then method will return null.- Specified by:
postProcess
in interfaceConsoleEngine
- Parameters:
line
- command lineresult
- command result to processoutput
- command redirected output- Returns:
- processed result
-
postProcess
Description copied from interface:ConsoleEngine
Post processes execution result.- Specified by:
postProcess
in interfaceConsoleEngine
- Parameters:
result
- command result to process- Returns:
- processed result
-
invoke
public Object invoke(CommandRegistry.CommandSession session, String command, Object... args) throws Exception Description copied from interface:CommandRegistry
Execute a command.- Specified by:
invoke
in interfaceCommandRegistry
- Overrides:
invoke
in classAbstractCommandRegistry
- Parameters:
session
- the data of the current command sessioncommand
- the name of the commandargs
- arguments of the command- Returns:
- result of the command execution
- Throws:
Exception
- in case of error
-
trace
Description copied from interface:ConsoleEngine
Print object if trace is enabled- Specified by:
trace
in interfaceConsoleEngine
- Parameters:
object
- object to print
-
println
Description copied from interface:ConsoleEngine
Print object.- Specified by:
println
in interfaceConsoleEngine
- Parameters:
object
- object to print
-
persist
Description copied from interface:ConsoleEngine
Persist object to file- Specified by:
persist
in interfaceConsoleEngine
- Parameters:
file
- file where object should be writtenobject
- object to persist
-
slurp
Description copied from interface:ConsoleEngine
Read object from file- Specified by:
slurp
in interfaceConsoleEngine
- Parameters:
file
- file from where object should be read- Returns:
- object
- Throws:
IOException
- in case of error
-