io.permazen.parse.func

Class AllFunction

java.lang.Object

io.permazen.parse.func.AbstractFunction

io.permazen.parse.func.AllFunction

All Implemented Interfaces:

Function

public class AllFunction
extends AbstractFunction

Field Summary

Fields inherited from class io.permazen.parse.func.AbstractFunction

log, name, spaceParser

Constructor Summary

Constructors

Constructor and Description
AllFunction()

Method Summary

Modifier and Type	Method and Description
Value	apply(ParseSession session, Object param) Evaluate this function.
String	getHelpDetail() Get expanded help (typically multiple lines).
String	getHelpSummary() Get summarized help (typically a single line).
String	getUsage() Get function usage string.
Object	parseParams(ParseSession session, ParseContext ctx, boolean complete) Parse function parameters.

Methods inherited from class io.permazen.parse.func.AbstractFunction

getName, getSessionModes, parseExpressionParams, parseNextParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

AllFunction

public AllFunction()

Method Detail

getHelpSummary

public String getHelpSummary()

Description copied from interface: Function

Get summarized help (typically a single line).

Returns:

one line summarized description of this function

getUsage

public String getUsage()

Description copied from interface: Function

Get function usage string. For example: pow(base, exponent).

Returns:

function usage string

getHelpDetail

public String getHelpDetail()

Description copied from class: AbstractFunction

Get expanded help (typically multiple lines). May refer to the usage string.

The implementation in AbstractFunction delegates to getHelpSummary().

The implementation in AbstractFunction just delegates to getHelpSummary().

Specified by:

getHelpDetail in interface Function

Overrides:

getHelpDetail in class AbstractFunction

Returns:

detailed description of this function

parseParams

public Object parseParams(ParseSession session,
                          ParseContext ctx,
                          boolean complete)

Description copied from interface: Function

Parse function parameters.

The ctx will be pointing at the first parameter (if any) or closing parenthesis. This method should parse (but not evaluate) function parameters up through the closing parenthesis. The return value is an opaque value representing the parsed parameters and subsequently passed to apply().

Parameters:

session - parse session

ctx - parse context

complete - false if parse is "for real", true if only for tab completion calculation

Returns:

parsed parameters object to be passed to apply()

apply

public Value apply(ParseSession session,
                   Object param)

Description copied from interface: Function

Evaluate this function. There will be a transaction open.

Parameters:

session - parse session

param - parsed parameters returned by parseParams()

Returns:

value returned by this function