CodeBlock (ExpressionJ javadoc)

java.lang.Object
- org.expressionj.expr.CodeBlock

All Implemented Interfaces:

java.lang.Cloneable, Expression, ExpressionType
```
public class CodeBlock
extends java.lang.Object
implements Expression
```
A code block containing several "<do something>;", each being one Expression.
Examples
The following expression c=a+b;d=c*2;return d; will perform the following computations:
- c is the result of a+b
- d is c * 2
- return d as the result of the evaluation
The equation will also have two side-effects in this case: set the value for c and d.
The following expression c=a+b;d=c*2; will have exactly the same result.

Field Summary

Fields
Modifier and Type Field and Description

protected CodeBlock block
- Fields inherited from interface org.expressionj.model.ExpressionType
  STRUCT_ARRAY, STRUCT_SCALAR, STRUCT_STRUCTURE, TYPE_BOOL, TYPE_DYNAMIC, TYPE_FLOAT, TYPE_INTEGER, TYPE_NUMERIC, TYPE_STRING, TYPE_UNDEF

Fields
Modifier and Type	Field and Description
`protected CodeBlock`	`block`

Constructor Summary

Constructors
Constructor and Description

CodeBlock(Expression root)

Constructors
Constructor and Description
`CodeBlock(Expression root)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExpression(Expression expr)` Add an expression to the block.
`java.lang.Object`	`clone()`
`int`	`countExpressions()` Return the number of expressions.
`java.lang.Object`	`eval()` Evaluate the expression.
`boolean`	`evalAsBoolean()` Evaluate the expression as a boolean.
`float`	`evalAsFloat()` Evaluate the expression as a float.
`int`	`evalAsInt()` Evaluate the expression as an int.
`java.lang.String`	`getExpressionName()` Return the expression name.
`java.util.List<Expression>`	`getExpressions()` Return the expressions.
`ExprWHILE`	`getExprWHILE()`
`LocalVariable`	`getLocalVariable(java.lang.String varName)` Return the internal variable of a specified name.
`java.util.Map<java.lang.String,LocalVariable>`	`getLocalVariables()` Return the internal variables of the block.
`CodeBlock`	`getParentBlock()` Return the parent expression block if the expression is one of several expressions separated by commas.
`short`	`getResultStructure()` Return the structure of the result for the expression.
`short`	`getResultType()` Return the type of the result for the expression.
`Expression`	`getRoot()` Return the root expression.
`Variable`	`getVariable(java.lang.String varName)` Return a variable declared by the expression.
`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.
`boolean`	`hasVariable(java.lang.String varName, boolean includeLocals)` Return true if there is a variable with a specified name.
`Expression`	`lastExpression()` Return the last expression.
`boolean`	`replaceLastExpression(Expression expr)` Replace the last expression of the block.
`void`	`setExpressions(java.util.List<Expression> expressions)` Set the expressions.
`void`	`setExprWHILE(ExprWHILE exprWHILE)`
`void`	`setLocalVariables(java.util.Map<java.lang.String,LocalVariable> internalVars)` Set the internal variables of the block.
`void`	`setParentBlock(CodeBlock block)` Set the parent expression block.

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

Methods inherited from interface org.expressionj.model.Expression
getExpression, getVariables, hasVariable, removeVariable

- Field Detail
  - block
```
protected CodeBlock block
```
- Constructor Detail
  - CodeBlock
```
public CodeBlock(Expression root)
```
- Method Detail
  - getRoot
```
public Expression getRoot()
```
    Return the root expression.
    
    Specified by:
    
    getRoot in interface Expression
    
    Returns:
    
    the root expression
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Specified by:
    
    clone in interface Expression
    
    Overrides:
    
    clone in class java.lang.Object
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - setExprWHILE
```
public void setExprWHILE(ExprWHILE exprWHILE)
```
  - getExprWHILE
```
public ExprWHILE getExprWHILE()
```
  - setParentBlock
```
public void setParentBlock(CodeBlock block)
```
    Description copied from interface: Expression
    
    Set the parent expression block.
    
    Specified by:
    
    setParentBlock in interface Expression
    
    Parameters:
    
    block - the parent expression block
  - getParentBlock
```
public CodeBlock getParentBlock()
```
    Description copied from interface: Expression
    
    Return the parent expression block if the expression is one of several expressions separated by commas. For example, in the following equation: b=a+2; return b, the two "b=a+2" and "return b" have "b=a+2; return b" as their parent block.
    
    Specified by:
    
    getParentBlock in interface Expression
    
    Returns:
    
    the parent expression block
  - replaceLastExpression
```
public boolean replaceLastExpression(Expression expr)
```
    Replace the last expression of the block. Nothing will be done if the block is empty.
    
    Parameters:
    
    expr - the expression to use for the replacement
    
    Returns:
    
    true if there was at least one expression in the block
  - lastExpression
```
public Expression lastExpression()
```
    Return the last expression.
    
    Returns:
    
    the last expression
  - countExpressions
```
public int countExpressions()
```
    Return the number of expressions.
    
    Returns:
    
    the number of expressions
  - addExpression
```
public void addExpression(Expression expr)
```
    Add an expression to the block.
    
    Parameters:
    
    expr - the expression
  - getExpressions
```
public java.util.List<Expression> getExpressions()
```
    Return the expressions.
    
    Returns:
    
    the expressions
  - setExpressions
```
public void setExpressions(java.util.List<Expression> expressions)
```
    Set the expressions.
    
    Parameters:
    
    expressions - the expression
  - eval
```
public java.lang.Object eval()
```
    Description copied from interface: Expression
    
    Evaluate the expression.
    
    Specified by:
    
    eval in interface Expression
    
    Returns:
    
    the result
  - getVariables
```
public java.util.Map<java.lang.String,Variable> getVariables()
```
    Description copied from interface: Expression
    
    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.
    
    Specified by:
    
    getVariables in interface Expression
    
    Returns:
    
    the variables used by this expression
  - getLocalVariable
```
public LocalVariable getLocalVariable(java.lang.String varName)
```
    Return the internal variable of a specified name.
    
    Specified by:
    
    getLocalVariable in interface Expression
    
    Parameters:
    
    varName - the variable name
    
    Returns:
    
    the internal variable
  - getVariable
```
public Variable getVariable(java.lang.String varName,
                            boolean includeLocals)
```
    Return a variable declared by the expression.
    
    Specified by:
    
    getVariable in interface Expression
    
    Parameters:
    
    varName - the variable name
    
    includeLocals - true if local variables should be included
    
    Returns:
    
    the variable
  - hasVariable
```
public boolean hasVariable(java.lang.String varName,
                           boolean includeLocals)
```
    Return true if there is a variable with a specified name.
    
    Specified by:
    
    hasVariable in interface Expression
    
    Parameters:
    
    varName - the variable name
    
    includeLocals - true if local variables should be included
    
    Returns:
    
    true if there is a variable with the specified name
  - setLocalVariables
```
public void setLocalVariables(java.util.Map<java.lang.String,LocalVariable> internalVars)
```
    Set the internal variables of the block.
    
    Parameters:
    
    internalVars - the internal variables
  - getLocalVariables
```
public java.util.Map<java.lang.String,LocalVariable> getLocalVariables()
```
    Return the internal variables of the block.
    
    Specified by:
    
    getLocalVariables in interface Expression
    
    Returns:
    
    the internal variables
  - getExpressionName
```
public java.lang.String getExpressionName()
```
    Description copied from interface: Expression
    
    Return the expression name.
    
    Specified by:
    
    getExpressionName in interface Expression
    
    Returns:
    
    the expression name
  - getVariable
```
public Variable getVariable(java.lang.String varName)
```
    Description copied from interface: Expression
    
    Return a variable declared by the expression.
    
    Specified by:
    
    getVariable in interface Expression
    
    Parameters:
    
    varName - the variable name
    
    Returns:
    
    the variable
  - evalAsInt
```
public int evalAsInt()
```
    Description copied from interface: Expression
    
    Evaluate the expression as an int. The result of the evaluation will be the same as Expression.eval(), but the evaluation engine will be able to optimize the computation by knwoing that the result is an int (primitive valeus are cached internally).
    
    Specified by:
    
    evalAsInt in interface Expression
    
    Returns:
    
    the result as an int
  - evalAsFloat
```
public float evalAsFloat()
```
    Description copied from interface: Expression
    
    Evaluate the expression as a float. The result of the evaluation will be the same as Expression.eval(), but the evaluation engine will be able to optimize the computation by knwoing that the result is a float (primitive valeus are cached internally).
    
    Specified by:
    
    evalAsFloat in interface Expression
    
    Returns:
    
    the result as a float
  - evalAsBoolean
```
public boolean evalAsBoolean()
```
    Description copied from interface: Expression
    
    Evaluate the expression as a boolean. The result of the evaluation will be the same as Expression.eval(), but the evaluation engine will be able to optimize the computation by knwoing that the result is a boolean (primitive valeus are cached internally).
    
    Specified by:
    
    evalAsBoolean in interface Expression
    
    Returns:
    
    the result as a boolean
  - getResultType
```
public short getResultType()
```
    Description copied from interface: Expression
    Return the type of the result for the expression. The type can be:
    - ExpressionType.TYPE_INTEGER: integer
    - ExpressionType.TYPE_FLOAT: float
    - ExpressionType.TYPE_NUMERIC: integer or float value. The runtime actual type may depend on the expression arguments
    - ExpressionType.TYPE_STRING: string
    - ExpressionType.TYPE_DYNAMIC: dynamic type. The runtime actual type may depend on the expression arguments
    - ExpressionType.TYPE_UNDEF: undefined type. The default type, characteristic of an error if entountered.
    Specified by:
    
    getResultType in interface Expression
    
    Returns:
    
    the type of the result for the expression
  - getResultStructure
```
public short getResultStructure()
```
    Description copied from interface: Expression
    Return the structure of the result for the expression. The structure can be:
    - ExpressionType.STRUCT_SCALAR: a scalar value
    - ExpressionType.STRUCT_ARRAY: an array value
    Specified by:
    
    getResultStructure in interface Expression
    
    Returns:
    
    he structure of the result for the expression

Class CodeBlock

Examples

Field Summary

Fields inherited from interface org.expressionj.model.ExpressionType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.expressionj.model.Expression

Field Detail

block

Constructor Detail

CodeBlock

Method Detail

getRoot

clone

setExprWHILE

getExprWHILE

setParentBlock

getParentBlock

replaceLastExpression

lastExpression

countExpressions

addExpression

getExpressions

setExpressions

eval

getVariables

getLocalVariable

getVariable

hasVariable

setLocalVariables

getLocalVariables

getExpressionName

getVariable

evalAsInt

evalAsFloat

evalAsBoolean

getResultType

getResultStructure