Class AviatorEvaluator

java.lang.Object

com.googlecode.aviator.AviatorEvaluator

public final class AviatorEvaluator
extends Object

Avaitor Expression evaluator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	AviatorEvaluator.StaticHolder

Field Summary

Fields

Modifier and Type	Field	Description
static int	BYTECODE_VER	Deprecated.
static final int	COMPILE	Optimized for compile speed
static final int	EVAL	Optimized for execute speed,this is the default option
static final Map<String,Object>	FUNC_MAP	Deprecated. please use instance's field.
static final Map<OperatorType, AviatorFunction>	OPS_MAP	Deprecated. please use instance's field.
static final String	VERSION	Aviator version

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AviatorEvaluator()

Method Summary

Modifier and Type	Method	Description
static void	addFunction(AviatorFunction function)	Add an aviator function,it's not thread-safe.
static void	addFunctionLoader(FunctionLoader loader)	Adds a function loader.
static List<String>	addInstanceFunctions(String namespace, Class<?> clazz)
static void	addOpFunction(OperatorType opType, AviatorFunction function)	Add an operator aviator function,it's not thread-safe.
static List<String>	addStaticFunctions(String namespace, Class<?> clazz)
static void	clearExpressionCache()	Clear all cached compiled expression
static Expression	compile(String expression)	Compile a text expression to Expression Object without caching
static Expression	compile(String expression, boolean cached)	Compile a text expression to Expression object
static Expression	compile(String cacheKey, String expression, boolean cached)	Compile a text expression to Expression object and cache it with the specified cache key
static boolean	containsFunction(String name)	Check if the function exists in the global evaluator instance.
static void	defineFunction(String name, String expression)	Define a function by name and expression.
static void	defineFunction(String name, String expression, Map<String,Object> env)	Define a function by name and expression with the execution env.
static Object	exec(String expression, Object... values)	Deprecated.
static Object	execute(String expression)	Execute a text expression without caching and env map.
static Object	execute(String cacheKey, String expression, Map<String,Object> env, boolean cached)	Execute a text expression with environment
static Object	execute(String expression, Map<String,Object> env)	Execute a text expression without caching
static Object	execute(String expression, Map<String,Object> env, boolean cached)	Execute a text expression with environment
static AviatorClassLoader	getAviatorClassLoader()	Returns classloader
static AviatorClassLoader	getAviatorClassLoader(boolean cached)	Returns classloader
static Expression	getCachedExpression(String expression)	Returns a compiled expression in cache
static AviatorFunction	getFunction(String name)	Retrieve an aviator function by name,throw exception if not found or null.It's not thread-safe.
static FunctionMissing	getFunctionMissing()
static AviatorEvaluatorInstance	getInstance()	Get the default evaluator instance
static MathContext	getMathContext()	Deprecated. Please use getOption(Options)
static AviatorFunction	getOpFunction(OperatorType opType)	Retrieve an operator aviator function by op type, return null if not found.It's not thread-safe.
static <T> T	getOption(Options opt)	Deprecated.
static Options.Value	getOptionValue(Options opt)	Returns the current evaluator option value union, returns null if missing.
static OutputStream	getTraceOutputStream()	Get current trace output stream,default is System.out
static List<String>	importFunctions(Class<?> clazz)
static void	invalidateCache(String expression)	Invalidate expression cache
static Map<String,Object>	newEnv(Object... args)	A helper method to generate a env object.
static AviatorEvaluatorInstance	newInstance()	Create a aviator script engine instance.
static AviatorEvaluatorInstance	newInstance(EvalMode evalMode)	Create a aviator script engine instance with eval mode
static AviatorFunction	removeFunction(AviatorFunction function)	Remove a aviator function
static AviatorFunction	removeFunction(String name)	Remove an aviator function by name,it's not thread-safe.
static void	removeFunctionLoader(FunctionLoader loader)	Removes a function loader.
static AviatorFunction	removeOpFunction(OperatorType opType)	Remove an operator aviator function by op type, it's not thread-safe.
static void	setAviatorClassLoader(AviatorClassLoader aviatorClassLoader)	Deprecated.
static void	setBYTECODE_VER(int nversion)
static void	setFunctionMissing(FunctionMissing functionMissing)
static void	setMathContext(MathContext mathContext)	Deprecated. please use setOption(Options, Object)
static void	setOptimize(int value)	Deprecated. please use setOption(Options, Object)
static void	setOption(Options opt, Object val)	Adds a evaluator option
static void	setTraceOutputStream(OutputStream traceOutputStream)	Set trace output stream
static void	validate(String script)

Methods inherited from class Object

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

Field Details

COMPILE

public static final int COMPILE

Optimized for compile speed

See Also:

• Constant Field Values

EVAL

public static final int EVAL

Optimized for execute speed,this is the default option

See Also:

• Constant Field Values

VERSION

public static final String VERSION

Aviator version

FUNC_MAP

@Deprecated
public static final Map<String,Object> FUNC_MAP

Deprecated.

please use instance's field.

The global evaluator's functions map.

See Also:

• AviatorEvaluatorInstance.getFuncMap()

OPS_MAP

@Deprecated
public static final Map<OperatorType, AviatorFunction> OPS_MAP

Deprecated.

please use instance's field.

The global evaluator's operators map.

See Also:

• AviatorEvaluatorInstance.getOpsMap()

BYTECODE_VER

@Deprecated
public static int BYTECODE_VER

Deprecated.

The global evaluator's byte code version.

See Also:

• AviatorEvaluatorInstance.getBytecodeVersion()

Constructor Details

AviatorEvaluator

private AviatorEvaluator()

Method Details

newInstance

public static AviatorEvaluatorInstance newInstance(EvalMode evalMode)

Create a aviator script engine instance with eval mode

Returns:

the script engine

Since:

5.3

newInstance

public static AviatorEvaluatorInstance newInstance()

Create a aviator script engine instance.

Returns:

the script engine

getInstance

public static AviatorEvaluatorInstance getInstance()

Get the default evaluator instance

Returns:

Since:

4.0.0

newEnv

public static Map<String,Object> newEnv(Object... args)

A helper method to generate a env object. The arguments should be a sequence of pair invalid input: '<'String, Object>.

Parameters:

args -

Returns:

A new env instance contains arguments.

Since:

4.2.9

addFunctionLoader

public static void addFunctionLoader(FunctionLoader loader)

Adds a function loader.

Parameters:

loader -

Since:

4.0.0

See Also:

• FunctionLoader

removeFunctionLoader

public static void removeFunctionLoader(FunctionLoader loader)

Removes a function loader.

Parameters:

loader -

Since:

4.0.0

See Also:

• FunctionLoader

setFunctionMissing

public static void setFunctionMissing(FunctionMissing functionMissing)

Parameters:

functionMissing -

See Also:

• AviatorEvaluatorInstance.setFunctionMissing(FunctionMissing)

getFunctionMissing

public static FunctionMissing getFunctionMissing()

Parameters:

functionMissing -

See Also:

• invalid reference

  AviatorEvaluatorInstance#getFunctionMissing(FunctionMissing)

setOption

public static void setOption(Options opt,
 Object val)

Adds a evaluator option

Parameters:

opt -

val -

Since:

2.3.4

See Also:

• Options

getOption

@Deprecated
public static <T> T getOption(Options opt)

Deprecated.

Returns the current evaluator option value, returns null if missing. use getOptionValue(Options) instead.

Parameters:

opt -

Returns:

getOptionValue

public static Options.Value getOptionValue(Options opt)

Returns the current evaluator option value union, returns null if missing.

Parameters:

opt -

Returns:

the option value, null if missing.

getTraceOutputStream

public static OutputStream getTraceOutputStream()

Get current trace output stream,default is System.out

Returns:

getMathContext

@Deprecated
public static MathContext getMathContext()

Deprecated.

Please use getOption(Options)

Returns current math context for decimal.

Returns:

Since:

2.3.0

setMathContext

@Deprecated
public static void setMathContext(MathContext mathContext)

Deprecated.

please use setOption(Options, Object)

Set math context for decimal.

Parameters:

mathContext -

Since:

2.3.0

setTraceOutputStream

public static void setTraceOutputStream(OutputStream traceOutputStream)

Set trace output stream

Parameters:

traceOutputStream -

setOptimize

@Deprecated
public static void setOptimize(int value)

Deprecated.

please use setOption(Options, Object)

set optimize level,default AviatorEvaluator.EVAL

Parameters:

value -

See Also:

• COMPILE
• EVAL

setBYTECODE_VER

public static void setBYTECODE_VER(int nversion)

clearExpressionCache

public static void clearExpressionCache()

Clear all cached compiled expression

getAviatorClassLoader

public static AviatorClassLoader getAviatorClassLoader()

Returns classloader

Returns:

getAviatorClassLoader

public static AviatorClassLoader getAviatorClassLoader(boolean cached)

Returns classloader

Returns:

addInstanceFunctions

public static List<String> addInstanceFunctions(String namespace,
 Class<?> clazz)
                                         throws IllegalAccessException,
NoSuchMethodException

Throws:

IllegalAccessException

NoSuchMethodException

See Also:

• AviatorEvaluatorInstance.addInstanceFunctions(String, Class)

addStaticFunctions

public static List<String> addStaticFunctions(String namespace,
 Class<?> clazz)
                                       throws IllegalAccessException,
NoSuchMethodException

Throws:

IllegalAccessException

NoSuchMethodException

See Also:

• AviatorEvaluatorInstance.addStaticFunctions(String, Class)

importFunctions

public static List<String> importFunctions(Class<?> clazz)
                                    throws IllegalAccessException,
NoSuchMethodException

Throws:

IllegalAccessException

NoSuchMethodException

See Also:

• AviatorEvaluatorInstance.importFunctions(Class)

addFunction

public static void addFunction(AviatorFunction function)

Add an aviator function,it's not thread-safe.

Parameters:

function -

defineFunction

public static void defineFunction(String name,
 String expression)

Define a function by name and expression.

Parameters:

name - the function name

expression - the expression to be executed and it's result must be a function.

Since:

4.0.0

defineFunction

public static void defineFunction(String name,
 String expression,
 Map<String,Object> env)

Define a function by name and expression with the execution env.

Parameters:

name - the function name

expression - the expression to be executed and it's result must be a function.

env - the expression execution env

Since:

4.0.0

removeFunction

public static AviatorFunction removeFunction(String name)

Remove an aviator function by name,it's not thread-safe.

Parameters:

name -

Returns:

getFunction

public static AviatorFunction getFunction(String name)

Retrieve an aviator function by name,throw exception if not found or null.It's not thread-safe.

Parameters:

name -

Returns:

addOpFunction

public static void addOpFunction(OperatorType opType,
 AviatorFunction function)

Add an operator aviator function,it's not thread-safe.

Parameters:

function -

getOpFunction

public static AviatorFunction getOpFunction(OperatorType opType)

Retrieve an operator aviator function by op type, return null if not found.It's not thread-safe.

Parameters:

opType -

Returns:

Since:

3.3

removeOpFunction

public static AviatorFunction removeOpFunction(OperatorType opType)

Remove an operator aviator function by op type, it's not thread-safe.

Parameters:

opType -

Returns:

Since:

3.3

containsFunction

public static boolean containsFunction(String name)

Check if the function exists in the global evaluator instance.

Parameters:

name -

Returns:

removeFunction

public static AviatorFunction removeFunction(AviatorFunction function)

Remove a aviator function

Parameters:

function -

Returns:

setAviatorClassLoader

@Deprecated
public static void setAviatorClassLoader(AviatorClassLoader aviatorClassLoader)

Deprecated.

Configure user defined classloader

Parameters:

aviatorClassLoader -

getCachedExpression

public static Expression getCachedExpression(String expression)

Returns a compiled expression in cache

Parameters:

expression -

Returns:

compile

public static Expression compile(String cacheKey,
 String expression,
 boolean cached)

Compile a text expression to Expression object and cache it with the specified cache key

Parameters:

cacheKey - cache key

expression - text expression

cached - Whether to cache the compiled result,make true to cache it.

Returns:

compile

public static Expression compile(String expression,
 boolean cached)

Compile a text expression to Expression object

Parameters:

expression - text expression

cached - Whether to cache the compiled result,make true to cache it.

Returns:

compile

public static Expression compile(String expression)

Compile a text expression to Expression Object without caching

Parameters:

expression -

Returns:

validate

public static void validate(String script)

Parameters:

script -

See Also:

• AviatorEvaluatorInstance.validate(String)

exec

@Deprecated
public static Object exec(String expression,
 Object... values)

Deprecated.

Execute a text expression with values that are variables order in the expression.It only runs in EVAL mode,and it will cache the compiled expression. It's deprecated, please use execute(String, Map) instead.

Parameters:

expression -

values -

Returns:

execute

public static Object execute(String cacheKey,
 String expression,
 Map<String,Object> env,
 boolean cached)

Execute a text expression with environment

Parameters:

cacheKey - unique key for caching

expression - text expression

env - Binding variable environment

cached - Whether to cache the compiled result,make true to cache it.

execute

public static Object execute(String expression,
 Map<String,Object> env,
 boolean cached)

Execute a text expression with environment

Parameters:

expression - text expression

env - Binding variable environment

cached - Whether to cache the compiled result,make true to cache it.

execute

public static Object execute(String expression,
 Map<String,Object> env)

Execute a text expression without caching

Parameters:

expression -

env -

Returns:

invalidateCache

public static void invalidateCache(String expression)

Invalidate expression cache

Parameters:

expression -

execute

public static Object execute(String expression)

Execute a text expression without caching and env map.

Parameters:

expression -

Returns: