Package nz.org.riskscape.engine.function

Class ConstantFunction

java.lang.Object

nz.org.riskscape.engine.function.ConstantFunction

All Implemented Interfaces:

AutoCloseable, RiskscapeFunction, UntypedFunction

public class ConstantFunction
extends Object
implements RiskscapeFunction

A RiskscapeFunction that always returns the same value

Field Summary

Fields inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

BUILT_IN, LOG

Constructor Summary

Constructors

Constructor	Description
ConstantFunction(Object value, Type type)

Method Summary

Modifier and Type	Method	Description
Object	call(List<Object> args)	Execute the function with the given arguments.
List<Type>	getArgumentTypes()
Type	getReturnType()
static ConstantFunction	returning(Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.org.riskscape.engine.function.RiskscapeFunction

builtin, close, getAggregationFunction, getArguments, getOverloaded, getRealizable, getTypesFromArguments, identified, identified, isA, setProblemReporter, validate

Constructor Details

ConstantFunction

public ConstantFunction(Object value,
 Type type)

Method Details

returning

public static ConstantFunction returning(Object value)

call

public Object call(List<Object> args)

Description copied from interface: UntypedFunction

Execute the function with the given arguments.

Specified by:

call in interface UntypedFunction

Parameters:

args - list of arguments to the function that should conform to the types in ArgumentList.getArgumentTypes()

getArgumentTypes

public List<Type> getArgumentTypes()

Specified by:

getArgumentTypes in interface RiskscapeFunction

Returns:

the types that this function expects

getReturnType

public Type getReturnType()

Specified by:

getReturnType in interface RiskscapeFunction

Returns:

the type that this function should return