com.github.jlangch.venice

Class Venice

java.lang.Object

com.github.jlangch.venice.Venice

public class Venice
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	disableTimer()
void	enableTimer()
java.lang.Object	eval(PreCompiled precompiled) Evaluates a pre-compiled script without passing any parameters.
java.lang.Object	eval(PreCompiled precompiled, 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.
java.lang.Object	eval(java.lang.String script, java.util.Map<java.lang.String,java.lang.Object> params) Evaluates a script with parameters
java.lang.Object	eval(java.lang.String scriptName, java.lang.String script) Evaluates a script with parameters
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
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
java.util.Collection<Timer>	getTimerData()
java.lang.String	getTimerDataFormatted(java.lang.String title)
static java.lang.String	getVersion()
PreCompiled	precompile(java.lang.String scriptName, java.lang.String script) Pre-compiles a Venice script with disabled up-front macro expansion.
PreCompiled	precompile(java.lang.String scriptName, java.lang.String script, boolean macroexpand) Pre-compiles a Venice script.
void	resetTimer()

Methods inherited from class java.lang.Object

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

Constructor Detail

Venice

public Venice()

Venice

public Venice(IInterceptor interceptor)

Create new sandboxed Venice instance

Parameters:

interceptor - an optional interceptor that defines the sandbox

Method Detail

precompile

public PreCompiled 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 PreCompiled precompile(java.lang.String scriptName,
                              java.lang.String script,
                              boolean macroexpand)

Pre-compiles a Venice script.

Parameters:

scriptName - A mandatory script name

script - A mandatory script

macroexpand - If true expand macros up-front

Returns:

the pre-compiled script

eval

public java.lang.Object eval(PreCompiled 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(PreCompiled precompiled,
                             java.util.Map<java.lang.String,java.lang.Object> params)

Evaluates a pre-compiled script with parameters.

Parameters:

precompiled - A mandatory pre-compiled script

params - Optional parameters

Returns:

the result

eval

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

Evaluates a script.

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 parameters

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

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

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

Parameters:

scriptName - An optional scriptName

script - A mandatory script

macroexpand - If true expand macros upfront

params - The optional parameters

Returns:

The result

getVersion

public static java.lang.String getVersion()

Returns:

the Venice version

enableTimer

public void enableTimer()

disableTimer

public void disableTimer()

resetTimer

public void resetTimer()

getTimerData

public java.util.Collection<Timer> getTimerData()

getTimerDataFormatted

public java.lang.String getTimerDataFormatted(java.lang.String title)