Package org.openhab.core.model.script.extension

Class ScriptEngineConsoleCommandExtension

java.lang.Object

org.openhab.core.io.console.extensions.AbstractConsoleCommandExtension

org.openhab.core.model.script.extension.ScriptEngineConsoleCommandExtension

All Implemented Interfaces:

ConsoleCommandExtension

@NonNullByDefault
public class ScriptEngineConsoleCommandExtension
extends AbstractConsoleCommandExtension

This class provides the script engine as a console command

Author:

Oliver Libutzki - Initial contribution

Constructor Summary

Constructors

Constructor	Description
ScriptEngineConsoleCommandExtension()

Method Summary

Modifier and Type	Method	Description
void	execute(String[] args, Console console)	This method called if a command for that extension is called.
List<String>	getUsages()
void	setScriptEngine(ScriptEngine scriptEngine)
void	unsetScriptEngine(ScriptEngine scriptEngine)

Methods inherited from class org.openhab.core.io.console.extensions.AbstractConsoleCommandExtension

buildCommandUsage, buildCommandUsage, getCommand, getDescription, printUsage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.io.console.extensions.ConsoleCommandExtension

getCompleter

Constructor Details

ScriptEngineConsoleCommandExtension

public ScriptEngineConsoleCommandExtension()

Method Details

execute

public void execute(String[] args,
 Console console)

Description copied from interface: ConsoleCommandExtension

This method called if a command for that extension is called. Clients are not allowed to throw exceptions. They have to write corresponding messages to the given Console

Parameters:

args - array which contains all the console command arguments

console - the console used to print

getUsages

public List<String> getUsages()

Returns:

the help texts for this extension

setScriptEngine

public void setScriptEngine(ScriptEngine scriptEngine)

unsetScriptEngine

public void unsetScriptEngine(ScriptEngine scriptEngine)