com.udojava.evalex

Class Expression.Function

java.lang.Object

com.udojava.evalex.Expression.Function

Enclosing class:

Expression

public abstract class Expression.Function
extends Object

Abstract definition of a supported expression function. A function is defined by a name, the number of parameters and the actual processing implementation.

Constructor Summary

Constructors

Constructor and Description
Expression.Function(String name, int numParams) Creates a new function with given name and parameter count.

Method Summary

Methods

Modifier and Type	Method and Description
abstract BigDecimal	eval(List<BigDecimal> parameters) Implementation for this function.
String	getName()
int	getNumParams()
boolean	numParamsVaries()

Methods inherited from class java.lang.Object

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

Constructor Detail

Expression.Function

public Expression.Function(String name,
                   int numParams)

Creates a new function with given name and parameter count.

Parameters:

name - The name of the function.

numParams - The number of parameters for this function. -1 denotes a variable number of parameters.

Method Detail

getName

public String getName()

getNumParams

public int getNumParams()

numParamsVaries

public boolean numParamsVaries()

eval

public abstract BigDecimal eval(List<BigDecimal> parameters)

Implementation for this function.

Parameters:

parameters - Parameters will be passed by the expression evaluator as a List of BigDecimal values.

Returns:

The function must return a new BigDecimal value as a computing result.