org.scripthelper.debug.expr

Interface Expression

All Known Subinterfaces:

AryExpression, Equation, UnaryExpression, Value

All Known Implementing Classes:

AbstractAryExpression, AbstractAryNumericExpression, AbstractExpression, AbstractUnaryExpression, AbstractUnaryNumericExpression, AbstractValue, Constant, ExprADD, ExprAND, ExprDIV, ExprEQ, ExprGE, ExprGT, ExprLE, ExprLT, ExprMOD, ExprMULT, ExprNEQ, ExprNOT, ExprOR, ExprSUB, ExprXOR, ParsedEquation, Variable

public interface Expression

Repredent any expression that can be evaluated. Expressions can be of several different kinds:

Since:

1.3

Method Summary

Modifier and Type	Method and Description
java.lang.Object	eval() Evaluate the expression.
default Expression	getExpression() Return the associated expression.
java.lang.String	getExpressionName() Return the expression name.
Expression	getRoot() Return the root expression.
default Variable	getVariable(java.lang.String varName) Return a variable declared by the expression.
default Variable	getVariable(java.lang.String varName, boolean includeLocals) Return a variable declared by the expression.
java.util.Map<java.lang.String,Variable>	getVariables() Return the variables used by this expression.
default java.util.Map<java.lang.String,Variable>	getVariables(boolean includeLocals) Return the variables used by this expression, possibly including local variables.
default boolean	hasVariable(java.lang.String varName) Return true if there is a variable with a specified name.
default boolean	hasVariable(java.lang.String varName, boolean includeLocals) Return true if there is a variable with a specified name.

Method Detail

getExpression

default Expression getExpression()

Return the associated expression. Return this by default.

Returns:

the associated expression

getRoot

Expression getRoot()

Return the root expression.

Returns:

the root expression

eval

java.lang.Object eval()

Evaluate the expression.

Returns:

the result

getExpressionName

java.lang.String getExpressionName()

Return the expression name.

Returns:

the expression name

getVariables

java.util.Map<java.lang.String,Variable> getVariables()

Return the variables used by this expression. Note that this method will not return any internal variables declared by the expression. For example, in the following expression: int c=a+b, only "a" and "b" will be returned.

Returns:

the variables used by this expression

getVariables

default java.util.Map<java.lang.String,Variable> getVariables(boolean includeLocals)

Return the variables used by this expression, possibly including local variables.

Parameters:

includeLocals - true if local variables should be included

Returns:

the variables used by this expression

getVariable

default Variable getVariable(java.lang.String varName)

Return a variable declared by the expression.

Parameters:

varName - the variable name

Returns:

the variable

hasVariable

default boolean hasVariable(java.lang.String varName)

Return true if there is a variable with a specified name.

Parameters:

varName - the variable name

Returns:

true if there is a variable with the specified name

getVariable

default Variable getVariable(java.lang.String varName,
                             boolean includeLocals)

Return a variable declared by the expression. The default implementation defer to getVariable(java.lang.String).

Parameters:

varName - the variable name

includeLocals - true if local variables should be included

Returns:

the variable

hasVariable

default boolean hasVariable(java.lang.String varName,
                            boolean includeLocals)

Return true if there is a variable with a specified name.

Parameters:

varName - the variable name

includeLocals - true if local variables should be included

Returns:

true if there is a variable with the specified name