com.github.jlangch.venice

Class Venice

java.lang.Object

com.github.jlangch.venice.Venice

public class Venice
extends java.lang.Object

Evaluator for Venice scripts

Constructor Summary

Constructors

Constructor and Description
Venice() Create new Venice instance without a sandbox
Venice(IInterceptor interceptor) Create new sandboxed Venice instance

Method Summary

Modifier and Type	Method and Description
java.lang.Object	eval(IPreCompiled precompiled) Evaluates a pre-compiled script without passing any parameters.
java.lang.Object	eval(IPreCompiled precompiledScript, java.util.Map<java.lang.String,java.lang.Object> params) Evaluates a pre-compiled script with parameters.
java.lang.Object	eval(java.lang.String script) Evaluates a script with disabled up-front macro expansion
java.lang.Object	eval(java.lang.String script, java.util.Map<java.lang.String,java.lang.Object> params) Evaluates a script with parameters and disabled up-front macro expansion
java.lang.Object	eval(java.lang.String scriptName, java.lang.String script) Evaluates a script with disabled up-front macro expansion
java.lang.Object	eval(java.lang.String scriptName, java.lang.String script, boolean macroexpand, java.util.Map<java.lang.String,java.lang.Object> params) Evaluates a script with parameters and optional up-front macro expansion
java.lang.Object	eval(java.lang.String scriptName, java.lang.String script, java.util.Map<java.lang.String,java.lang.Object> params) Evaluates a script with parameters and disabled up-front macro expansion
FunctionExecutionMeter	getFunctionExecutionMeter()
long	getLastPrecompileElapsedTimeMillis()
static java.lang.String	getVersion()
IPreCompiled	precompile(java.lang.String scriptName, java.lang.String script) Pre-compiles a Venice script with disabled up-front macro expansion.
IPreCompiled	precompile(java.lang.String scriptName, java.lang.String script, boolean macroexpand) Pre-compiles a Venice script with optional up-front macro expansion
static void	shutdownExecutorServices() Shutdown all Venice executor services.

Methods inherited from class java.lang.Object

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

Constructor Detail

Venice

public Venice()

Create new Venice instance without a sandbox

Venice

public Venice(IInterceptor interceptor)

Create new sandboxed Venice instance

Parameters:

interceptor - an optional interceptor that defines the sandbox

Method Detail

precompile

public IPreCompiled precompile(java.lang.String scriptName,
                               java.lang.String script)

Pre-compiles a Venice script with disabled up-front macro expansion.

Note: for best performance up-front macro expansion should be enabled for pre-compilation!

Parameters:

scriptName - A mandatory script name

script - A mandatory script

Returns:

the pre-compiled script

precompile

public IPreCompiled precompile(java.lang.String scriptName,
                               java.lang.String script,
                               boolean macroexpand)

Pre-compiles a Venice script with optional up-front macro expansion

Parameters:

scriptName - A mandatory script name

script - A mandatory script

macroexpand - If true expand macros up-front (this can speed-up execution significantly)

Returns:

the pre-compiled script

eval

public java.lang.Object eval(IPreCompiled precompiled)

Evaluates a pre-compiled script without passing any parameters.

Parameters:

precompiled - A mandatory pre-compiled script

Returns:

the result

eval

public java.lang.Object eval(IPreCompiled precompiledScript,
                             java.util.Map<java.lang.String,java.lang.Object> params)

Evaluates a pre-compiled script with parameters.

Parameters:

precompiledScript - A mandatory pre-compiled script

params - Optional parameters

Returns:

the result

eval

public java.lang.Object eval(java.lang.String script)

Evaluates a script with disabled up-front macro expansion

Parameters:

script - A mandatory script

Returns:

The result

eval

public java.lang.Object eval(java.lang.String scriptName,
                             java.lang.String script)

Evaluates a script with disabled up-front macro expansion

Parameters:

scriptName - An optional scriptName

script - A mandatory script

Returns:

The result

eval

public java.lang.Object eval(java.lang.String script,
                             java.util.Map<java.lang.String,java.lang.Object> params)

Evaluates a script with parameters and disabled up-front macro expansion

Parameters:

script - A mandatory script

params - Optional parameters

Returns:

The result

eval

public java.lang.Object eval(java.lang.String scriptName,
                             java.lang.String script,
                             java.util.Map<java.lang.String,java.lang.Object> params)

Evaluates a script with parameters and disabled up-front macro expansion

Parameters:

scriptName - An optional scriptName

script - A mandatory script

params - The optional parameters

Returns:

The result

eval

public java.lang.Object eval(java.lang.String scriptName,
                             java.lang.String script,
                             boolean macroexpand,
                             java.util.Map<java.lang.String,java.lang.Object> params)

Evaluates a script with parameters and optional up-front macro expansion

Parameters:

scriptName - An optional scriptName

script - A mandatory script

macroexpand - If true expand macros up-front (this can speed-up execution significantly)

params - The optional parameters

Returns:

The result

getFunctionExecutionMeter

public FunctionExecutionMeter getFunctionExecutionMeter()

Returns:

the function meter that manages collected runtime execution time for functions

getLastPrecompileElapsedTimeMillis

public long getLastPrecompileElapsedTimeMillis()

Returns:

the elapsed time in milliseconds for the last pre-compilation, or -1 if there wasn't a pre-compilation yet.

getVersion

public static java.lang.String getVersion()

Returns:

the Venice version

shutdownExecutorServices

public static void shutdownExecutorServices()

Shutdown all Venice executor services.

Be aware that executor services are shared across multiple Venice instances. After shutdown, some Venice functions like agents may not work anymore.