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

Class HelpFunction

java.lang.Object

com.github.basking2.sdsai.itrex.functions.HelpFunction

All Implemented Interfaces:

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

public class HelpFunction
extends Object
implements FunctionInterface<String>, HelpfulFunction

A function that fetches function help text.

Constructor Summary

Constructors

Constructor	Description
HelpFunction()

Method Summary

Modifier and Type	Method	Description
String	apply(Iterator<? extends Object> args, 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

HelpFunction

public HelpFunction()

Method Details

apply

public String apply(Iterator<? extends Object> args,
 EvaluationContext evaluationContext)

Specified by:

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

functionHelp

public String functionHelp(String name,
 boolean verbose)

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.