au.com.codeka.carrot.expr

Class Function

java.lang.Object

au.com.codeka.carrot.expr.Function

public class Function
extends java.lang.Object

A function identifier and a list of arguments to that function. See StatementParser for the full EBNF.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Function.Builder Simple builder class for Function.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	evaluate(java.lang.Object value, Configuration config, Scope scope) Evaluate this function on the given object, with the given Configuration and Scope.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

evaluate

public java.lang.Object evaluate(java.lang.Object value,
                                 Configuration config,
                                 Scope scope)
                          throws CarrotException

Evaluate this function on the given object, with the given Configuration and Scope.

Parameters:

value - The value to evaluate this function on. That is, the object on which we want to call the function this object represents.

config - The current Configuration.

scope - The current Scope.

Returns:

The result of calling the function (i.e. the function's return value).

Throws:

CarrotException - if there's any exceptions calling the function.