AbstractValue (ExpressionJ javadoc)

java.lang.Object
- org.expressionj.model.AbstractExpression
- - org.expressionj.model.AbstractValue

All Implemented Interfaces:

java.lang.Cloneable, Equation, Expression, ExpressionType, Value

Direct Known Subclasses:

Constant, Variable
```
public abstract class AbstractValue
extends AbstractExpression
implements Value
```
An abstract value, used for Constants and variables.

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String name

protected short struct

protected short type

protected ValueWrapper value
- Fields inherited from class org.expressionj.model.AbstractExpression
  block, root
- 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 java.lang.String`	`name`
`protected short`	`struct`
`protected short`	`type`
`protected ValueWrapper`	`value`

Constructor Summary

Constructors
Constructor and Description

AbstractValue()

AbstractValue(Expression root)

Constructors
Constructor and Description
`AbstractValue()`
`AbstractValue(Expression root)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkType()`
`boolean`	`equals(java.lang.Object o)`
`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`	`getExpression()` Return the equation associated expression.
`java.lang.String`	`getName()`
`short`	`getStructure()` Return the value structure.
`short`	`getType()` Return the value type.
`java.lang.Object`	`getValue()` Return the value.
`boolean`	`getValueAsBoolean()` Return the value as a boolean.
`float`	`getValueAsFloat()` Return the value as a float.
`int`	`getValueAsInt()` Return the value as an int.
`int`	`hashCode()`
`protected void`	`initType()`
`protected void`	`setDefaultValue()` Set the default value for the type.
`void`	`setName(java.lang.String name)`
`void`	`setStructure(short struct)` Set the structure of the value.
`void`	`setType(short type)` Set the type of the value.
`void`	`setType(short type, short struct)` Set the type and structure of the value.
`void`	`setValue(java.lang.Object value)`
`void`	`setValueAsBoolean(boolean value)`
`void`	`setValueAsFloat(float value)`
`void`	`setValueAsInt(int value)`

Methods inherited from class org.expressionj.model.AbstractExpression
clone, getParentBlock, getRoot, setParentBlock, setRoot

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

Methods inherited from interface org.expressionj.model.Equation
setValue

Methods inherited from interface org.expressionj.model.Expression
clone, getExpressionName, getLocalVariable, getLocalVariables, getParentBlock, getResultStructure, getResultType, getRoot, getVariable, getVariable, getVariables, getVariables, hasVariable, hasVariable, removeVariable, setParentBlock

- Field Detail
  - type
```
protected short type
```
  - struct
```
protected short struct
```
  - value
```
protected ValueWrapper value
```
  - name
```
protected java.lang.String name
```
- Constructor Detail
  - AbstractValue
```
public AbstractValue()
```
  - AbstractValue
```
public AbstractValue(Expression root)
```
- Method Detail
  - setName
```
public void setName(java.lang.String name)
```
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface Value
  - setType
```
public final void setType(short type,
                          short struct)
```
    Set the type and structure of the value.
    
    Specified by:
    
    setType in interface Value
    
    Parameters:
    
    type - the type
    
    struct - the structure
  - setType
```
public final void setType(short type)
```
    Set the type of the value.
    
    Specified by:
    
    setType in interface Value
    
    Parameters:
    
    type - the type
  - setStructure
```
public final void setStructure(short struct)
```
    Set the structure of the value.
    
    Specified by:
    
    setStructure in interface Value
    
    Parameters:
    
    struct - the structure
  - setDefaultValue
```
protected void setDefaultValue()
```
    Set the default value for the type.
  - initType
```
protected void initType()
```
  - checkType
```
protected void checkType()
```
  - getExpression
```
public Expression getExpression()
```
    Description copied from interface: Equation
    
    Return the equation associated expression.
    
    Specified by:
    
    getExpression in interface Equation
    
    Specified by:
    
    getExpression in interface Expression
    
    Returns:
    
    the expression
  - getValue
```
public java.lang.Object getValue()
```
    Description copied from interface: Value
    
    Return the value. Note that this method will return null if the value is null.
    
    Specified by:
    
    getValue in interface Value
    
    Returns:
    
    the value
  - getValueAsInt
```
public int getValueAsInt()
```
    Description copied from interface: Value
    
    Return the value as an int. Note that this method will return false if the value if null.
    
    Specified by:
    
    getValueAsInt in interface Value
    
    Returns:
    
    the value as an int
  - getValueAsFloat
```
public float getValueAsFloat()
```
    Description copied from interface: Value
    
    Return the value as a float. Note that this method will return false if the value if null.
    
    Specified by:
    
    getValueAsFloat in interface Value
    
    Returns:
    
    the value as a float
  - getValueAsBoolean
```
public boolean getValueAsBoolean()
```
    Description copied from interface: Value
    
    Return the value as a boolean. Note that this method will return false if the value if null.
    
    Specified by:
    
    getValueAsBoolean in interface Value
    
    Returns:
    
    the value as a boolean
  - setValue
```
public void setValue(java.lang.Object value)
```
    Specified by:
    
    setValue in interface Value
  - setValueAsInt
```
public void setValueAsInt(int value)
```
    Specified by:
    
    setValueAsInt in interface Value
  - setValueAsFloat
```
public void setValueAsFloat(float value)
```
    Specified by:
    
    setValueAsFloat in interface Value
  - setValueAsBoolean
```
public void setValueAsBoolean(boolean value)
```
    Specified by:
    
    setValueAsBoolean in interface Value
  - evalAsInt
```
public final 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
    
    Overrides:
    
    evalAsInt in class AbstractExpression
    
    Returns:
    
    the result as an int
  - evalAsFloat
```
public final 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
    
    Overrides:
    
    evalAsFloat in class AbstractExpression
    
    Returns:
    
    the result as a float
  - evalAsBoolean
```
public final 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
    
    Overrides:
    
    evalAsBoolean in class AbstractExpression
    
    Returns:
    
    the result as a boolean
  - eval
```
public java.lang.Object eval()
                      throws java.lang.ArithmeticException
```
    Description copied from interface: Expression
    
    Evaluate the expression.
    
    Specified by:
    
    eval in interface Expression
    
    Returns:
    
    the result
    
    Throws:
    
    java.lang.ArithmeticException
  - getType
```
public short getType()
```
    Return the value type.
    
    Returns:
    
    the value type
  - getStructure
```
public short getStructure()
```
    Return the value structure.
    
    Returns:
    
    the value structure
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class AbstractValue

Field Summary

Fields inherited from class org.expressionj.model.AbstractExpression

Fields inherited from interface org.expressionj.model.ExpressionType

Constructor Summary

Method Summary

Methods inherited from class org.expressionj.model.AbstractExpression

Methods inherited from class java.lang.Object

Methods inherited from interface org.expressionj.model.Equation

Methods inherited from interface org.expressionj.model.Expression

Field Detail

type

struct

value

name

Constructor Detail

AbstractValue

AbstractValue

Method Detail

setName

getName

setType

setType

setStructure

setDefaultValue

initType

checkType

getExpression

getValue

getValueAsInt

getValueAsFloat

getValueAsBoolean

setValue

setValueAsInt

setValueAsFloat

setValueAsBoolean

evalAsInt

evalAsFloat

evalAsBoolean

eval

getType

getStructure

equals

hashCode