edu.stanford.nlp.ling.tokensregex.types

Interface ValueFunction

All Known Implementing Classes:

ValueFunctions.BooleanFunction, ValueFunctions.CompareFunction, ValueFunctions.NamedValueFunction, ValueFunctions.NumericFunction, ValueFunctions.StringFunction, ValueFunctions.TypeCheckedFunction

public interface ValueFunction

A function that takes as input a environment (Env) and a list of values (List), and returns a Value.

Author:

Angel Chang

Method Summary

Methods

Modifier and Type	Method and Description
Value	apply(Env env, List<Value> in) Applies the function to the list values using the environment as context and returns the evaluated value.
boolean	checkArgs(List<Value> in) Checks if the arguments are valid
String	getDescription() Returns a string describing what this function does

Method Detail

checkArgs

boolean checkArgs(List<Value> in)

Checks if the arguments are valid

Parameters:

in -

Returns:

true if the arguments are valid (false otherwise)

apply

Value apply(Env env,
          List<Value> in)

Applies the function to the list values using the environment as context and returns the evaluated value.

Parameters:

env - the environment to use

in - the input arguments

Returns:

Value indicating the value of the function

getDescription

String getDescription()

Returns a string describing what this function does

Returns:

String describing the function