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

Class ListFlattenFunction

java.lang.Object

com.github.basking2.sdsai.itrex.functions.ListFlattenFunction

All Implemented Interfaces:

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

public class ListFlattenFunction
extends Object
implements HelpfulFunction, FunctionInterface<List<Object>>

Flatten arguments and iterators into a list.

Constructor Summary

Constructors

Constructor	Description
ListFlattenFunction()

Method Summary

Modifier and Type	Method	Description
List<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

ListFlattenFunction

public ListFlattenFunction()

Method Details

apply

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

Specified by:

apply in interface BiFunction<Iterator<?>,EvaluationContext,List<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.