Package org.openhab.core.automation.module.script

Class AbstractScriptEngineFactory

java.lang.Object

org.openhab.core.automation.module.script.AbstractScriptEngineFactory

All Implemented Interfaces:

ScriptEngineFactory

@NonNullByDefault
public abstract class AbstractScriptEngineFactory
extends Object
implements ScriptEngineFactory

This is an abstract class for implementing ScriptEngineFactorys.

Author:

Scott Rushworth - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Fields inherited from interface org.openhab.core.automation.module.script.ScriptEngineFactory

CONTEXT_KEY_DEPENDENCY_LISTENER, CONTEXT_KEY_ENGINE_IDENTIFIER, CONTEXT_KEY_EXTENSION_ACCESSOR, ENGINE_MANAGER

Constructor Summary

Constructors

Constructor	Description
AbstractScriptEngineFactory()

Method Summary

Modifier and Type	Method	Description
@Nullable ScriptEngine	createScriptEngine(String scriptType)	This method creates a new ScriptEngine based on the supplied file extension or MimeType.
List<String>	getScriptTypes()	This method returns a list of file extensions and MimeTypes that are supported by the ScriptEngine, e.g.
void	scopeValues(ScriptEngine scriptEngine, Map<String,Object> scopeValues)	This method "scopes" new values into the given ScriptEngine.

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.automation.module.script.ScriptEngineFactory

getDependencyTracker

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

AbstractScriptEngineFactory

public AbstractScriptEngineFactory()

Method Details

getScriptTypes

public List<String> getScriptTypes()

Description copied from interface: ScriptEngineFactory

This method returns a list of file extensions and MimeTypes that are supported by the ScriptEngine, e.g. py, application/python, js, application/javascript, etc.

Specified by:

getScriptTypes in interface ScriptEngineFactory

Returns:

List of supported script types

scopeValues

public void scopeValues(ScriptEngine scriptEngine,
 Map<String,Object> scopeValues)

Description copied from interface: ScriptEngineFactory

This method "scopes" new values into the given ScriptEngine.

Specified by:

scopeValues in interface ScriptEngineFactory

createScriptEngine

public @Nullable ScriptEngine createScriptEngine(String scriptType)

Description copied from interface: ScriptEngineFactory

This method creates a new ScriptEngine based on the supplied file extension or MimeType.

Specified by:

createScriptEngine in interface ScriptEngineFactory

Parameters:

scriptType - a file extension (script) or MimeType (ScriptAction or ScriptCondition)

Returns:

ScriptEngine or null