org.expressionj.model

Class Variable

java.lang.Object

org.expressionj.model.AbstractExpression

org.expressionj.model.AbstractValue

org.expressionj.model.Variable

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalVariable, Structure, Structure.Field

public class Variable
extends AbstractValue

Represent a Variable.

Field Summary

Fields inherited from class org.expressionj.model.AbstractValue

name, struct, type, 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

Constructor Summary

Constructors

Constructor and Description
Variable(java.lang.String name) Constructor.
Variable(java.lang.String name, java.lang.Object value) Constructor.
Variable(java.lang.String name, short type) Constructor.
Variable(java.lang.String name, short type, java.lang.Object value) Constructor.
Variable(java.lang.String name, short type, java.lang.Object value, short struct) Constructor.
Variable(java.lang.String name, short type, short struct) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	equals(java.lang.Object o)
java.lang.String	getExpressionName() Return the variable name.
short	getResultStructure() Return the structure of the result for the expression.
short	getResultType() Return the type of the Variable.
Variable	getVariable(java.lang.String varName) Return the value of the variable.
java.util.Map<java.lang.String,Variable>	getVariables() Return the Map of variables.
int	hashCode()
boolean	isLocal() Return true if the variable is a local variable.
void	setValue(java.lang.String varName, java.lang.Object value) Set the value of the variable.

Methods inherited from class org.expressionj.model.AbstractValue

checkType, eval, evalAsBoolean, evalAsFloat, evalAsInt, getExpression, getName, getStructure, getType, getValue, getValueAsBoolean, getValueAsFloat, getValueAsInt, initType, setDefaultValue, setName, setStructure, setType, setType, setValue, setValueAsBoolean, setValueAsFloat, setValueAsInt

Methods inherited from class org.expressionj.model.AbstractExpression

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.Expression

getLocalVariable, getLocalVariables, getParentBlock, getRoot, getVariable, getVariables, hasVariable, hasVariable, removeVariable, setParentBlock

Constructor Detail

Variable

public Variable(java.lang.String name)

Constructor.

Parameters:

name - the variable name

Variable

public Variable(java.lang.String name,
                short type)

Constructor.

Parameters:

name - the variable name

type - the variable type

Variable

public Variable(java.lang.String name,
                short type,
                short struct)

Constructor.

Parameters:

name - the variable name

type - the variable type

struct - the variable structure

Variable

public Variable(java.lang.String name,
                short type,
                java.lang.Object value)

Constructor.

Parameters:

name - the variable name

type - the variable type

value - the variable value

Variable

public Variable(java.lang.String name,
                short type,
                java.lang.Object value,
                short struct)

Constructor.

Parameters:

name - the variable name

type - the variable type

struct - the variable structure

value - the variable value

Variable

public Variable(java.lang.String name,
                java.lang.Object value)

Constructor.

Parameters:

name - the variable name

value - the variable value

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression

Throws:

java.lang.CloneNotSupportedException

isLocal

public boolean isLocal()

Return true if the variable is a local variable. Return false by default.

Returns:

true if the variable is a local variable

getExpressionName

public java.lang.String getExpressionName()

Return the variable name.

Returns:

the variable name

getResultType

public short getResultType()

Return the type of the Variable.

Returns:

the type of the Variable

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

Returns:

he structure of the result for the expression

getVariables

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

Return the Map of variables. The method will return a singleton Map with only this Variable.

Returns:

the Map of variables

getVariable

public Variable getVariable(java.lang.String varName)

Return the value of the variable. The method will return null if the provided name is not equal to this variable name.

Parameters:

varName - the variable name

Returns:

the variable value

setValue

public void setValue(java.lang.String varName,
                     java.lang.Object value)

Set the value of the variable. The value will only be set if the provided name is equal to this variable name.

Parameters:

varName - the variable name

value - the variable value

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractValue

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractValue