Package com.github.basking2.sdsai.itrex.functions

Class LetFunction

java.lang.Object

com.github.basking2.sdsai.itrex.functions.LetFunction

All Implemented Interfaces:

FunctionInterface<Object>, HelpfulFunction, BiFunction<Iterator<?>,EvaluationContext,Object>

public class LetFunction
extends Object
implements FunctionInterface<Object>, HelpfulFunction

Constructor Summary

Constructors

Constructor	Description
LetFunction()

Method Summary

Modifier and Type	Method	Description
Object	apply(Iterator<?> iterator, EvaluationContext evaluationContext)
String	functionHelp(String name, boolean verbose)	Returns help text for how this function should be used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Constructor Details

LetFunction

public LetFunction()

Method Details

apply

public Object apply(Iterator<?> iterator,
 EvaluationContext evaluationContext)

Specified by:

apply in interface BiFunction<Iterator<?>,EvaluationContext,Object>

functionHelp

public String functionHelp(String name,
 boolean verbose)

Description copied from interface: HelpfulFunction

Returns help text for how this function should be used.

Specified by:

functionHelp in interface HelpfulFunction

Parameters:

name - The name the function is called. Functions may have aliases.

verbose - Should this help be verbose or simplistic.

Returns:

A string that describes how to use a function. This may be a Markdown formatted string.