io.permazen.cli.func

Class PrintFunction

java.lang.Object

io.permazen.parse.func.AbstractFunction

io.permazen.parse.func.SimpleFunction

io.permazen.cli.func.SimpleCliFunction

io.permazen.cli.func.PrintFunction

All Implemented Interfaces:

Function

public class PrintFunction
extends SimpleCliFunction

Field Summary

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

maxArgs, minArgs

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

log, name, spaceParser

Constructor Summary

Constructors

Constructor and Description
PrintFunction()

Method Summary

Modifier and Type	Method and Description
protected Value	apply(CliSession session, Value[] params) Apply this function to the given values.
String	getHelpSummary() Get summarized help (typically a single line).
EnumSet<SessionMode>	getSessionModes() Get the SessionMode(s) supported by this instance.
String	getUsage() Get function usage string.

Methods inherited from class io.permazen.cli.func.SimpleCliFunction

apply

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

apply, getMaxArgs, getMinArgs, parseParams

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

getHelpDetail, getName, parseExpressionParams, parseNextParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintFunction

public PrintFunction()

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

getSessionModes

public EnumSet<SessionMode> getSessionModes()

Description copied from class: AbstractFunction

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

Overrides:

getSessionModes in class AbstractFunction

Returns:

supported SessionModes

apply

protected Value apply(CliSession session,
                      Value[] params)

Description copied from class: SimpleCliFunction

Apply this function to the given values.

Specified by:

apply in class SimpleCliFunction

Parameters:

session - CLI session

params - parsed parameters; will already be checked between SimpleFunction.getMinArgs() and SimpleFunction.getMaxArgs()

Returns:

value returned by this function