org.expressionj.model

Class Constant

java.lang.Object

org.expressionj.model.AbstractExpression

org.expressionj.model.AbstractValue

org.expressionj.model.Constant

All Implemented Interfaces:

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

public class Constant
extends AbstractValue

Represent a Constant.

Field Summary

Fields

Modifier and Type	Field and Description
static Constant	EMPTY_STRING The constant which hold an empty String.
static Constant	FALSE The constant which hold the value false.
static Constant	ONE_F The constant which hold the value 1 as an float.
static Constant	ONE_I The constant which hold the value 1 as an int.
static Constant	TRUE The constant which hold the value true.
static Constant	ZERO_F The constant which hold the value 0 as a float.
static Constant	ZERO_I The constant which hold the value 0 as an int.

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
Constant(Expression root, java.lang.Object value) Constructor.
Constant(java.lang.Object value) Constructor.
Constant(java.lang.Object value, short type) Constructor.
Constant(java.lang.Object value, short type, short struct) Constructor.
Constant(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 expression name.
short	getResultStructure() Return the structure of the result for the expression.
short	getResultType() Return the type of the result for the expression.
Variable	getVariable(java.lang.String varName) Return null.
java.util.Map<java.lang.String,Variable>	getVariables() Return an empty Map.
int	hashCode()
void	setValue(java.lang.String varName, java.lang.Object value) Do nothing.

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

Field Detail

TRUE

public static final Constant TRUE

The constant which hold the value true.

FALSE

public static final Constant FALSE

The constant which hold the value false.

ZERO_I

public static final Constant ZERO_I

The constant which hold the value 0 as an int.

ZERO_F

public static final Constant ZERO_F

The constant which hold the value 0 as a float.

ONE_I

public static final Constant ONE_I

The constant which hold the value 1 as an int.

ONE_F

public static final Constant ONE_F

The constant which hold the value 1 as an float.

EMPTY_STRING

public static final Constant EMPTY_STRING

The constant which hold an empty String.

Constructor Detail

Constant

public Constant(java.lang.Object value)

Constructor.

Parameters:

value - the value

Constant

public Constant(Expression root,
                java.lang.Object value)

Constructor.

Parameters:

value - the value

Constant

public Constant(java.lang.Object value,
                short type)

Constructor.

Parameters:

value - the value

type - the type

Constant

public Constant(short type,
                short struct)

Constructor.

Parameters:

type - the type

struct - the structure

Constant

public Constant(java.lang.Object value,
                short type,
                short struct)

Constructor.

Parameters:

type - the type

struct - the structure

value - the 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

getExpressionName

public java.lang.String getExpressionName()

Description copied from interface: Expression

Return the expression name.

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.

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

Returns:

he structure of the result for the expression

getVariables

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

Return an empty Map.

Returns:

the variables used by this expression

getVariable

public Variable getVariable(java.lang.String varName)

Return null.

Parameters:

varName - the variable name

Returns:

the variable

setValue

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

Do nothing.

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