com.googlecode.aviator

Enum Options

java.lang.Object

java.lang.Enum<Options>

com.googlecode.aviator.Options

All Implemented Interfaces:

Serializable, Comparable<Options>

public enum Options
extends Enum<Options>

Aviator Evaluator Configuration options.

Author:

dennis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Options.Value The option's value union

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_PARSE_FLOATING_POINT_NUMBER_INTO_DECIMAL Always parsing floating-point number into BigDecial, default is false.It replaces ALWAYS_USE_DOUBLE_AS_DECIMAL option.
ALWAYS_USE_DOUBLE_AS_DECIMAL Deprecated. This is a name typo option, please use #ALWAYS_USE_DECIMAL_AS_FLOATING_POINT_NUMBER instead.
ENABLE_PROPERTY_SYNTAX_SUGAR Enable property access syntax sugar, use common-beantuils to access property such as "a.b.c" etc.
MATH_CONTEXT Math context for decimal, default is MathContext.DECIMAL128
NIL_WHEN_PROPERTY_NOT_FOUND When enable property access syntax sugar, returns nil if the property value is not found or throws exception.Default value is false,disabled this behaviour.
OPTIMIZE_LEVEL Optimize level, default is AviatorEvaluator.EVAL
PUT_CAPTURING_GROUPS_INTO_ENV Whether to put capturing groups into passed-in env map when regular-expression pattern matches, default is true.If you don't want the groups, you can turn it off to get better performance in regular-expression pattern matching.
TRACE Deprecated.
TRACE_EVAL Whether to trace expression evaluating procedure, default is false.
USE_USER_ENV_AS_TOP_ENV_DIRECTLY Whether to use user passed-in env as top level environment directly.If true, it may make side effects(such as assignment) to user passed-in env., otherwise aviator will wrap the user passed-in env and does not make any side effects into it.

Field Summary

Fields

Modifier and Type	Field and Description
static Options.Value	COMPILE_VALUE
static Options.Value	DEFAULT_MATH_CONTEXT
static Options.Value	EVAL_VALUE
static Options.Value	FALSE_VALUE
static Options.Value	TRUE_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue() Returns the default value of option.
Options.Value	getDefaultValueObject() Returns the default value object of option.
Object	intoObject(Options.Value val) Cast value union into java object.
Options.Value	intoValue(Object val) Cast java object into value union.
boolean	isValidValue(Object val)
static Options	valueOf(String name) Returns the enum constant of this type with the specified name.
static Options[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS_USE_DOUBLE_AS_DECIMAL

public static final Options ALWAYS_USE_DOUBLE_AS_DECIMAL

Deprecated. This is a name typo option, please use #ALWAYS_USE_DECIMAL_AS_FLOATING_POINT_NUMBER instead.

Always use double as BigDecimal, default is false.

Since:

2.3.4

OPTIMIZE_LEVEL

public static final Options OPTIMIZE_LEVEL

Optimize level, default is AviatorEvaluator.EVAL

See Also:

AviatorEvaluator.EVAL, AviatorEvaluator.COMPILE

MATH_CONTEXT

public static final Options MATH_CONTEXT

Math context for decimal, default is MathContext.DECIMAL128

See Also:

MathContext

TRACE

public static final Options TRACE

Deprecated.

Whether to trace code generation,default is false.

ALWAYS_PARSE_FLOATING_POINT_NUMBER_INTO_DECIMAL

public static final Options ALWAYS_PARSE_FLOATING_POINT_NUMBER_INTO_DECIMAL

Always parsing floating-point number into BigDecial, default is false.It replaces ALWAYS_USE_DOUBLE_AS_DECIMAL option.

TRACE_EVAL

public static final Options TRACE_EVAL

Whether to trace expression evaluating procedure, default is false.

PUT_CAPTURING_GROUPS_INTO_ENV

public static final Options PUT_CAPTURING_GROUPS_INTO_ENV

Whether to put capturing groups into passed-in env map when regular-expression pattern matches, default is true.If you don't want the groups, you can turn it off to get better performance in regular-expression pattern matching.

ENABLE_PROPERTY_SYNTAX_SUGAR

public static final Options ENABLE_PROPERTY_SYNTAX_SUGAR

Enable property access syntax sugar, use common-beantuils to access property such as "a.b.c" etc. Default value is true, enable this behaviour.

NIL_WHEN_PROPERTY_NOT_FOUND

public static final Options NIL_WHEN_PROPERTY_NOT_FOUND

When enable property access syntax sugar, returns nil if the property value is not found or throws exception.Default value is false,disabled this behaviour.

USE_USER_ENV_AS_TOP_ENV_DIRECTLY

public static final Options USE_USER_ENV_AS_TOP_ENV_DIRECTLY

Whether to use user passed-in env as top level environment directly.If true, it may make side effects(such as assignment) to user passed-in env., otherwise aviator will wrap the user passed-in env and does not make any side effects into it. Default is false.

Field Detail

FALSE_VALUE

public static final Options.Value FALSE_VALUE

TRUE_VALUE

public static final Options.Value TRUE_VALUE

DEFAULT_MATH_CONTEXT

public static final Options.Value DEFAULT_MATH_CONTEXT

EVAL_VALUE

public static final Options.Value EVAL_VALUE

COMPILE_VALUE

public static final Options.Value COMPILE_VALUE

Method Detail

values

public static Options[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Options c : Options.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Options valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

intoObject

public Object intoObject(Options.Value val)

Cast value union into java object.

Parameters:

val -

Returns:

intoValue

public Options.Value intoValue(Object val)

Cast java object into value union.

Parameters:

val -

Returns:

isValidValue

public boolean isValidValue(Object val)

getDefaultValue

public Object getDefaultValue()

Returns the default value of option.

Returns:

getDefaultValueObject

public Options.Value getDefaultValueObject()

Returns the default value object of option.

Returns: