cvm.model
Class Macro

java.lang.Object
  cvm.model.Macro

public class Macro
extends java.lang.Object

This class encapsulates all the data specific to any macro. This object simplifies the transfer of information across subsystems dealing with macros.

Author:

Frank Hernandez and Eduardo Monteiro

Constructor Summary

Macro()

Method Summary

java.lang.String	getName() This method returns the name of the macro
java.util.ArrayList	getParamNameList() This method returns a list containing the name of the parameters inside a macro.
java.util.ArrayList	getParamTypeList() This method returns a list containing the types of all the parameters in a macro.
java.lang.String	getReturnType() This method returns the return type of a macro.
java.lang.String	getScript() This function returns a string representation of a script.
java.util.ArrayList	getThrownExceptions() Returns the list of thrown exceptions.
void	setName(java.lang.String name) This sets the name of the macro.
void	setParamNameList(java.util.ArrayList paramNameList) This method sets the list of parameter names.
void	setParamTypeList(java.util.ArrayList paramTypeList) This method set the list of parameters types of a macro.
void	setReturnType(java.lang.String returnType) This method sets the return type of a macro.
void	setScript(java.lang.String script) Sets the execution section of a macro.
void	setThrownExceptions(java.util.ArrayList thrownExceptions) Assignes the list of thrown excpetions.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Macro

public Macro()

Method Detail

getParamNameList

public java.util.ArrayList getParamNameList()

This method returns a list containing the name of the parameters inside a macro.

Returns:

List of Macro Parameter Names

setParamNameList

public void setParamNameList(java.util.ArrayList paramNameList)

This method sets the list of parameter names.

Parameters:

paramNameList -

getParamTypeList

public java.util.ArrayList getParamTypeList()

This method returns a list containing the types of all the parameters in a macro.

Returns:

List of type of parameters.

setParamTypeList

public void setParamTypeList(java.util.ArrayList paramTypeList)

This method set the list of parameters types of a macro.

Parameters:

paramTypeList -

getScript

public java.lang.String getScript()

This function returns a string representation of a script. That is it retuns the execution section of a macro in string format.

Returns:

String contining the execution section of a macro.

setScript

public void setScript(java.lang.String script)

Sets the execution section of a macro.

Parameters:

script -

getReturnType

public java.lang.String getReturnType()

This method returns the return type of a macro.

Returns:

The return type of the macro.

setReturnType

public void setReturnType(java.lang.String returnType)

This method sets the return type of a macro.

Parameters:

returnType -

getName

public java.lang.String getName()

This method returns the name of the macro

Returns:

Name of the macro.

setName

public void setName(java.lang.String name)

This sets the name of the macro.

Parameters:

name -

setThrownExceptions

public void setThrownExceptions(java.util.ArrayList thrownExceptions)

Assignes the list of thrown excpetions.

Parameters:

thrownExceptions -

getThrownExceptions

public java.util.ArrayList getThrownExceptions()

Returns the list of thrown exceptions.

Returns:

exceptions thrown by macro execution

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object