io.permazen.parse.func

Class AbstractFunction

java.lang.Object

io.permazen.parse.func.AbstractFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AllFunction, CreateFunction, QueryCompositeIndexFunction, QueryIndexFunction, QueryListElementIndexFunction, QueryMapValueIndexFunction, QueryVersionFunction, SimpleFunction

public abstract class AbstractFunction
extends Object
implements Function

Support superclass for Functions.

See Also:

Function

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	log
protected String	name
protected SpaceParser	spaceParser

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFunction(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getHelpDetail() Get expanded help (typically multiple lines).
String	getName() Get the name of this function.
EnumSet<SessionMode>	getSessionModes() Get the SessionMode(s) supported by this instance.
protected Node[]	parseExpressionParams(ParseSession session, ParseContext ctx, boolean complete, int skippedArgs, int minArgs, int maxArgs) Parse some number of Java expression function arguments.
protected Node	parseNextParameter(ParseSession session, ParseContext ctx, boolean complete, int skippedArgs, List<Node> paramList) Parse the next function parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.permazen.parse.func.Function

apply, getHelpSummary, getUsage, parseParams

Field Detail

log

protected final Logger log

spaceParser

protected final SpaceParser spaceParser

name

protected final String name

Constructor Detail

AbstractFunction

protected AbstractFunction(String name)

Constructor.

Parameters:

name - function name

Method Detail

getName

public String getName()

Description copied from interface: Function

Get the name of this function.

Specified by:

getName in interface Function

Returns:

function name

getHelpDetail

public String getHelpDetail()

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

Returns:

detailed description of this function

getSessionModes

public EnumSet<SessionMode> getSessionModes()

Get the SessionMode(s) supported by this instance.

The implementation in AbstractFunction returns an EnumSet containing SessionMode.CORE_API and SessionMode.PERMAZEN.

Specified by:

getSessionModes in interface Function

Returns:

supported SessionModes

parseExpressionParams

protected Node[] parseExpressionParams(ParseSession session,
                                       ParseContext ctx,
                                       boolean complete,
                                       int skippedArgs,
                                       int minArgs,
                                       int maxArgs)

Parse some number of Java expression function arguments. We assume we have parsed the opening parenthesis, zero or more previous arguments followed by commas, and optional whitespace. This will parse through the closing parenthesis.

Parameters:

session - parse session

ctx - parse context

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

skippedArgs - the number of arguments already parsed

minArgs - minimum number of arguments

maxArgs - maximum number of arguments

Returns:

parsed expressions

Throws:

ParseException - if parse fails, or if complete is true and there are valid completions

parseNextParameter

protected Node parseNextParameter(ParseSession session,
                                  ParseContext ctx,
                                  boolean complete,
                                  int skippedArgs,
                                  List<Node> paramList)

Parse the next function parameter. Invoked by parseExpressionParams().

The implementation in AbstractFunction delegates to ExprParser.parse().

Parameters:

session - parse session

ctx - parse context

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

skippedArgs - the number of arguments parsed prior to parseExpressionParams()

paramList - the parameters already parsed by parseExpressionParams()

Returns:

parsed parameter

Throws:

ParseException - if parse fails, or if complete is true and there are valid completions