cvm.ucm.interpreter
Class EnvVariable

java.lang.Object
  cvm.ucm.interpreter.EnvVariable

public class EnvVariable
extends java.lang.Object

This class is used to hold the 'enviroment variables' needed by the macro to execute. For a macro to use a system variable in the system it must know the variable name as in the macro, the variable type (full declaration i.e. Java.lang.util.String) and the variable value (the variable name as seen in the class).

Author:

Frank Hernandez

Constructor Summary

EnvVariable(java.lang.String varName, java.lang.String typeName, java.lang.Object varValue)
Creates a new enviroment variable object.

Method Summary

java.lang.String	getParamName() This method returns the name of the variable as seen inside the macro.
java.lang.String	getParamType() This method returns the full classification of the variable.
java.lang.Object	getParamValue() This method returns the value to be given to the variable inside the macro.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnvVariable

public EnvVariable(java.lang.String varName,
                   java.lang.String typeName,
                   java.lang.Object varValue)

Creates a new enviroment variable object.

Parameters:

varName -

typeName -

varValue -

Method Detail

getParamName

public java.lang.String getParamName()

This method returns the name of the variable as seen inside the macro.

Returns:

variable name as seen in the macro.

getParamType

public java.lang.String getParamType()

This method returns the full classification of the variable.

Returns:

type name of the variable i.e. 'cvm.ncb.NetworkCommunicationBroker'

getParamValue

public java.lang.Object getParamValue()

This method returns the value to be given to the variable inside the macro. That is the variable as used inside the system.

Returns:

the value to be given to the variable inside the macro.