AviatorEvaluatorInstance (aviator 4.1.2 API)

java.lang.Object
- com.googlecode.aviator.AviatorEvaluatorInstance

public final class AviatorEvaluatorInstance
extends Object

A aviator evaluator instance

Since:: 4.0.0
Author:: dennis

Field Summary

Fields
Modifier and Type Field and Description

int bytecodeVersion
Generated java class version,default 1.6

Fields
Modifier and Type	Field and Description
`int`	`bytecodeVersion` Generated java class version,default 1.6

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFunction(AviatorFunction function)` Add an aviator function,it's not thread-safe.
`void`	`addFunction(String name, AviatorFunction function)` Adds a function with the name
`void`	`addFunctionLoader(FunctionLoader loader)` Adds a function loader
`void`	`addOpFunction(OperatorType opType, AviatorFunction function)` Add an operator aviator function,it's not thread-safe.
`void`	`clearExpressionCache()` Clear all cached compiled expression
`Expression`	`compile(String expression)` Compile a text expression to Expression Object without caching
`Expression`	`compile(String expression, boolean cached)` Compile a text expression to Expression object
`boolean`	`containsFunction(String name)` Check if the function is existed in aviator
`void`	`defineFunction(String name, String expression)` Define a function by name and expression.
`void`	`defineFunction(String name, String expression, Map<String,Object> env)` Define a function by name and expression with the execution env.
`Object`	`exec(String expression, Object... values)` 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.
`Object`	`execute(String expression)` Execute a text expression without caching and env map.
`Object`	`execute(String expression, Map<String,Object> env)` Execute a text expression without caching
`Object`	`execute(String expression, Map<String,Object> env, boolean cached)` Execute a text expression with environment
`AviatorClassLoader`	`getAviatorClassLoader()` Returns classloader
`AviatorClassLoader`	`getAviatorClassLoader(boolean cached)` Returns classloader
`int`	`getBytecodeVersion()` Returns the generated java classes byte code version, 1.6 by defualt.
`Expression`	`getCachedExpression(String expression)` Returns a compiled expression in cache
`int`	`getExpressionCacheSize()` Returns the number of cached expressions.
`Map<String,Object>`	`getFuncMap()` Returns the functions map
`AviatorFunction`	`getFunction(String name)` Retrieve an aviator function by name,throw exception if not found or null.It's not thread-safe.
`AviatorFunction`	`getOpFunction(OperatorType opType)` Retrieve an operator aviator function by op type, return null if not found.It's not thread-safe.
`Map<OperatorType,AviatorFunction>`	`getOpsMap()` Returns the operators map.
`<T> T`	`getOption(Options opt)` Deprecated.
`Map<Options,Object>`	`getOptions()` Get the evaluator instance options
`Options.Value`	`getOptionValue(Options opt)` Returns the current evaluator option value union, returns null if missing.
`OutputStream`	`getTraceOutputStream()` Get current trace output stream,default is System.out
`void`	`invalidateCache(String expression)` Invalidate expression cache
`boolean`	`isExpressionCached(String expression)` Returns true when the expression is in cache.
`CodeGenerator`	`newCodeGenerator(AviatorClassLoader classLoader)`
`CodeGenerator`	`newCodeGenerator(boolean cached)`
`AviatorFunction`	`removeFunction(AviatorFunction function)` Remove a aviator function
`AviatorFunction`	`removeFunction(String name)` Remove an aviator function by name,it's not thread-safe.
`void`	`removeFunctionLoader(FunctionLoader loader)` Remove a function loader
`AviatorFunction`	`removeOpFunction(OperatorType opType)` Remove an operator aviator function by op type, it's not thread-safe.
`void`	`setBytecodeVersion(int bytecodeVersion)` Set the generated java classes java byte code version.
`void`	`setOption(Options opt, Object val)` Adds a evaluator option
`void`	`setTraceOutputStream(OutputStream traceOutputStream)` Set trace output stream

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - bytecodeVersion
```
public int bytecodeVersion
```
    Generated java class version,default 1.6
- Method Detail
  - addFunctionLoader
```
public void addFunctionLoader(FunctionLoader loader)
```
    Adds a function loader
    
    Parameters:
    
    loader -
    
    Since:
    
    4.0.0
    
    See Also:
    
    FunctionLoader
  - removeFunctionLoader
```
public void removeFunctionLoader(FunctionLoader loader)
```
    Remove a function loader
    
    Parameters:
    
    loader -
    
    Since:
    
    4.0.0
  - setOption
```
public void setOption(Options opt,
                      Object val)
```
    Adds a evaluator option
    
    Parameters:
    
    opt -
    
    val -
    
    Since:
    
    2.3.4
    
    See Also:
    
    Options
  - getOption
```
@Deprecated
public <T> T getOption(Options opt)
```
    Deprecated.
    
    Returns the current evaluator option value, returns null if missing.
    
    Parameters:
    
    opt -
    
    Returns:
  - getOptionValue
```
public Options.Value getOptionValue(Options opt)
```
    Returns the current evaluator option value union, returns null if missing.
    
    Parameters:
    
    opt -
    
    Returns:
  - getBytecodeVersion
```
public int getBytecodeVersion()
```
    Returns the generated java classes byte code version, 1.6 by defualt.
    
    Returns:
  - setBytecodeVersion
```
public void setBytecodeVersion(int bytecodeVersion)
```
    Set the generated java classes java byte code version.
    
    Parameters:
    
    bytecodeVersion -
    
    See Also:
    
    Opcodes.V1_6
  - getOptions
```
public Map<Options,Object> getOptions()
```
    Get the evaluator instance options
    
    Returns:
  - getFuncMap
```
public Map<String,Object> getFuncMap()
```
    Returns the functions map
    
    Returns:
  - getOpsMap
```
public Map<OperatorType,AviatorFunction> getOpsMap()
```
    Returns the operators map.
    
    Returns:
  - getTraceOutputStream
```
public OutputStream getTraceOutputStream()
```
    Get current trace output stream,default is System.out
    
    Returns:
  - setTraceOutputStream
```
public void setTraceOutputStream(OutputStream traceOutputStream)
```
    Set trace output stream
    
    Parameters:
    
    traceOutputStream -
  - clearExpressionCache
```
public void clearExpressionCache()
```
    Clear all cached compiled expression
  - getAviatorClassLoader
```
public AviatorClassLoader getAviatorClassLoader()
```
    Returns classloader
    
    Returns:
  - getAviatorClassLoader
```
public AviatorClassLoader getAviatorClassLoader(boolean cached)
```
    Returns classloader
    
    Returns:
  - addFunction
```
public void addFunction(AviatorFunction function)
```
    Add an aviator function,it's not thread-safe.
    
    Parameters:
    
    function -
  - addFunction
```
public void addFunction(String name,
                        AviatorFunction function)
```
    Adds a function with the name
    
    Parameters:
    
    name -
    
    function -
  - defineFunction
```
public 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 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 AviatorFunction removeFunction(String name)
```
    Remove an aviator function by name,it's not thread-safe.
    
    Parameters:
    
    name -
    
    Returns:
  - getFunction
```
public 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 void addOpFunction(OperatorType opType,
                          AviatorFunction function)
```
    Add an operator aviator function,it's not thread-safe.
    
    Parameters:
    
    function -
  - getOpFunction
```
public 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 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 boolean containsFunction(String name)
```
    Check if the function is existed in aviator
    
    Parameters:
    
    name -
    
    Returns:
  - removeFunction
```
public AviatorFunction removeFunction(AviatorFunction function)
```
    Remove a aviator function
    
    Parameters:
    
    function -
    
    Returns:
  - getCachedExpression
```
public Expression getCachedExpression(String expression)
```
    Returns a compiled expression in cache
    
    Parameters:
    
    expression -
    
    Returns:
  - isExpressionCached
```
public boolean isExpressionCached(String expression)
```
    Returns true when the expression is in cache.
    
    Parameters:
    
    expression -
    
    Returns:
    
    Since:
    
    4.0.0
  - getExpressionCacheSize
```
public int getExpressionCacheSize()
```
    Returns the number of cached expressions.
    
    Returns:
    
    Since:
    
    4.0.0
  - compile
```
public 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:
  - newCodeGenerator
```
public CodeGenerator newCodeGenerator(boolean cached)
```
  - newCodeGenerator
```
public CodeGenerator newCodeGenerator(AviatorClassLoader classLoader)
```
  - compile
```
public Expression compile(String expression)
```
    Compile a text expression to Expression Object without caching
    
    Parameters:
    
    expression -
    
    Returns:
  - exec
```
public Object exec(String expression,
                   Object... values)
```
    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.
    
    Parameters:
    
    expression -
    
    values -
    
    Returns:
  - execute
```
public 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 Object execute(String expression,
                      Map<String,Object> env)
```
    Execute a text expression without caching
    
    Parameters:
    
    expression -
    
    env -
    
    Returns:
  - invalidateCache
```
public void invalidateCache(String expression)
```
    Invalidate expression cache
    
    Parameters:
    
    expression -
  - execute
```
public Object execute(String expression)
```
    Execute a text expression without caching and env map.
    
    Parameters:
    
    expression -
    
    Returns:

Class AviatorEvaluatorInstance

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bytecodeVersion

Method Detail

addFunctionLoader

removeFunctionLoader

setOption

getOption

getOptionValue

getBytecodeVersion

setBytecodeVersion

getOptions

getFuncMap

getOpsMap

getTraceOutputStream

setTraceOutputStream

clearExpressionCache

getAviatorClassLoader

getAviatorClassLoader

addFunction

addFunction

defineFunction

defineFunction

removeFunction

getFunction

addOpFunction

getOpFunction

removeOpFunction

containsFunction

removeFunction

getCachedExpression

isExpressionCached

getExpressionCacheSize

compile

newCodeGenerator

newCodeGenerator

compile

exec

execute

execute

invalidateCache

execute