cetus.hir

Class FunctionCall

java.lang.Object

cetus.hir.Expression

cetus.hir.FunctionCall

All Implemented Interfaces:

Printable, Traversable, java.lang.Cloneable, java.lang.Comparable<Expression>

public class FunctionCall
extends Expression

Represents a function or method call.

Constructor Summary

Constructors

Constructor and Description
FunctionCall(Expression function, Expression... args) Creates a function call having no arguments.
FunctionCall(Expression function, java.util.List args) Creates a function call having a list of arguments.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(Expression expr) Inserts the specified expression at the end of the argument list.
FunctionCall	clone() Creates and returns a deep copy of this expression.
static void	defaultPrint(FunctionCall c, java.io.PrintWriter o) Prints a function call to a stream.
Expression	getArgument(int n) Returns the specified argument
java.util.List<Expression>	getArguments() Returns the list of arguments of the function call.
Expression	getName() Returns the name of the function call.
int	getNumArguments() Returns the number of arguments being passed to this function call.
Procedure	getProcedure() Returns the Procedure object for the function that is being called.
java.util.List	getReturnType() Returns the list of specifiers that define the return type of the function call.
void	setArgument(int n, Expression expr) Sets the argument at the specified position with the given new expression.
void	setArguments(java.util.List args) Sets the argument list with the specified list of new arguments.
static void	setClassPrintMethod(java.lang.reflect.Method m) Overrides the class print method, so that all subsequently created objects will use the supplied method.
void	setFunction(Expression expr) Sets the name of the function call with the specified new expression.
java.lang.String	toString() Returns a string representation of the function call.

Methods inherited from class cetus.hir.Expression

compareTo, equals, findExpression, getChildren, getParent, getStatement, hashCode, needsParens, print, printSelf, removeChild, setChild, setParens, setParent, setPrintMethod, swapWith, verify

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionCall

public FunctionCall(Expression function,
            Expression... args)

Creates a function call having no arguments.

Parameters:

function - An expression that evaluates to a function.

args - Arguments

Throws:

java.lang.IllegalArgumentException - if function is invalid.

NotAnOrphanException - if function has a parent object.

FunctionCall

public FunctionCall(Expression function,
            java.util.List args)

Creates a function call having a list of arguments.

Parameters:

function - An expression that evaluates to a function.

args - A list of arguments to the function.

Throws:

java.lang.IllegalArgumentException - if function or an element of args is invalid.

NotAnOrphanException - if function or an element of args has a parent object.

Method Detail

addArgument

public void addArgument(Expression expr)

Inserts the specified expression at the end of the argument list.

Parameters:

expr - the new argument to be inserted.

Throws:

java.lang.IllegalArgumentException - if expr is invalid.

NotAnOrphanException - if expr has a parent object.

defaultPrint

public static void defaultPrint(FunctionCall c,
                java.io.PrintWriter o)

Prints a function call to a stream.

Parameters:

c - The call to print.

o - The writer on which to print the call.

toString

public java.lang.String toString()

Returns a string representation of the function call. The returned string is equivalent to the printed stream through defaultPrint(cetus.hir.FunctionCall, java.io.PrintWriter).

Overrides:

toString in class Expression

Returns:

the string representation.

getArgument

public Expression getArgument(int n)

Returns the specified argument

Parameters:

n - - index of required argument (first argument has index zero)

Returns:

the argument at the specified position.

Throws:

java.lang.IllegalArgumentException - if n is out of range.

getArguments

public java.util.List<Expression> getArguments()

Returns the list of arguments of the function call.

Returns:

the argument list.

getName

public Expression getName()

Returns the name of the function call.

Returns:

the expression used as the function name.

getNumArguments

public int getNumArguments()

Returns the number of arguments being passed to this function call.

Returns:

the number of arguments.

getProcedure

public Procedure getProcedure()

Returns the Procedure object for the function that is being called.

Returns:

the Procedure object if found, null otherwise.

getReturnType

public java.util.List getReturnType()

Returns the list of specifiers that define the return type of the function call.

Returns:

the specifier list.

setArgument

public void setArgument(int n,
               Expression expr)

Sets the argument at the specified position with the given new expression.

Parameters:

n - the position of the arugment.

expr - the new argument.

Throws:

java.lang.IllegalArgumentException - if n or expr is invalid.

NotAnOrphanException - if expr has a parent object.

setArguments

public void setArguments(java.util.List args)

Sets the argument list with the specified list of new arguments.

Parameters:

args - the list of new arguments.

Throws:

java.lang.IllegalArgumentException - if an element of args is invalid.

NotAnOrphanException - if an element of args has a parent object.

setClassPrintMethod

public static void setClassPrintMethod(java.lang.reflect.Method m)

Overrides the class print method, so that all subsequently created objects will use the supplied method.

Parameters:

m - The new print method.

setFunction

public void setFunction(Expression expr)

Sets the name of the function call with the specified new expression.

Parameters:

expr - the expression to be used as a new name.

Throws:

java.lang.IllegalArgumentException - if expr is invalid.

NotAnOrphanException - if expr has a parent object.

clone

public FunctionCall clone()

Description copied from class: Expression

Creates and returns a deep copy of this expression.

Overrides:

clone in class Expression

Returns:

a deep copy of this expression.