csheets.core.formula.lang

Class Whiledo

java.lang.Object

csheets.core.formula.lang.Whiledo

All Implemented Interfaces:

Function

public class Whiledo
extends Object
implements Function

A function that implements a loop statement where the first condition was the stop argument and the next arguments are the execution statements

Author:

Andre

Field Summary

Fields

Modifier and Type	Field and Description
static FunctionParameter[]	parameters Parameters: condition, execution statements

Constructor Summary

Constructors

Constructor and Description
Whiledo() Create a new instance of function while do

Method Summary

Methods

Modifier and Type	Method and Description
Value	applyTo(Expression[] args) Invokes the function using the given arguments and returns the result.
String	getIdentifier() Returns the operator's string identirifer.
FunctionParameter[]	getParameters() Returns the parameters of the function.
boolean	isVarArg() Returns whether the function accepts a variable number of arguments, i.e. whether the function's parameter list is unbounded.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

public static final FunctionParameter[] parameters

Parameters: condition, execution statements

Constructor Detail

Whiledo

public Whiledo()

Create a new instance of function while do

Method Detail

getIdentifier

public String getIdentifier()

Description copied from interface: Function

Returns the operator's string identirifer.

Specified by:

getIdentifier in interface Function

Returns:

a string representation of the operator.

applyTo

public Value applyTo(Expression[] args)
              throws IllegalValueTypeException

Description copied from interface: Function

Invokes the function using the given arguments and returns the result.

Specified by:

applyTo in interface Function

Returns:

the result of the operation

Throws:

IllegalValueTypeException

getParameters

public FunctionParameter[] getParameters()

Description copied from interface: Function

Returns the parameters of the function.

Specified by:

getParameters in interface Function

Returns:

the parameters of the function

isVarArg

public boolean isVarArg()

Description copied from interface: Function

Returns whether the function accepts a variable number of arguments, i.e. whether the function's parameter list is unbounded.

Specified by:

isVarArg in interface Function

Returns:

true if the function accepts a variable number of arguments