ExprWHILE (ExpressionJ javadoc)

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

All Implemented Interfaces:

java.lang.Cloneable, Expression, ExpressionType
```
public class ExprWHILE
extends java.lang.Object
implements Expression
```
A while expression.

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

ExprWHILE(Expression root)

Constructors
Constructor and Description
`ExprWHILE(Expression root)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()`
`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.
`Expression`	`getCondition()`
`Expression`	`getExpression()` Return the associated expression.
`java.lang.String`	`getExpressionName()` Return the expression name.
`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.
`java.util.Map<java.lang.String,Variable>`	`getVariables()` Return the variables used by this expression.
`void`	`setBreak()`
`void`	`setCondition(Expression cond)`
`void`	`setExpression(Expression expr)`
`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
getLocalVariable, getLocalVariables, getVariable, getVariables, hasVariable, hasVariable, removeVariable

- Field Detail
  - block
```
protected CodeBlock block
```
- Constructor Detail
  - ExprWHILE
```
public ExprWHILE(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
  - 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
  - setCondition
```
public void setCondition(Expression cond)
```
  - getCondition
```
public Expression getCondition()
```
  - setExpression
```
public void setExpression(Expression expr)
```
  - getExpression
```
public Expression getExpression()
```
    Description copied from interface: Expression
    
    Return the associated expression. Return this by default.
    
    Specified by:
    
    getExpression in interface Expression
    
    Returns:
    
    the associated expression
  - 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
  - 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
  - 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
  - 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
  - eval
```
public java.lang.Object eval()
```
    Description copied from interface: Expression
    
    Evaluate the expression.
    
    Specified by:
    
    eval in interface Expression
    
    Returns:
    
    the result
  - 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
  - setBreak
```
public void setBreak()
```

Class ExprWHILE

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

ExprWHILE

Method Detail

getRoot

clone

setParentBlock

getParentBlock

setCondition

getCondition

setExpression

getExpression

getVariables

getExpressionName

getResultType

getResultStructure

evalAsInt

evalAsFloat

evalAsBoolean

eval

getVariable

setBreak