water.rapids.ast.prims.mungers

Class AstNrow

java.lang.Object

water.Iced<T>

water.rapids.ast.AstRoot<T>

water.rapids.ast.AstPrimitive

water.rapids.ast.prims.mungers.AstNrow

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable

public class AstNrow
extends AstPrimitive

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AstNrow()

Method Summary

Modifier and Type	Method and Description
ValNum	apply(Env env, Env.StackHelp stk, AstRoot[] asts) Primary method to invoke this function, passing all the parameters as the `asts` list.
java.lang.String[]	args() List of argument names.
java.lang.String	description() Return the detailed description (help) for what this language construct does or how it is supposed to be used.
java.lang.String	example() Return an example of how this Ast construct ought to be used.
int	nargs() Number of function's arguments + 1.
java.lang.String	str() String representation of this Ast object in the Rapids language.

Methods inherited from class water.rapids.ast.AstPrimitive

exec

Methods inherited from class water.rapids.ast.AstRoot

toString

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

AstNrow

public AstNrow()

Method Detail

args

public java.lang.String[] args()

Description copied from class: AstPrimitive

List of argument names. The length of the returned array should be equal to `nargs() - 1` (unless `nargs()` returns -1, in which case this function may return {"..."} or something similar).

Specified by:

args in class AstPrimitive

nargs

public int nargs()

Description copied from class: AstPrimitive

Number of function's arguments + 1. Thus, a binary operator like '+' should be declared with 3 nargs: ["+", lhs, rhs]. For variable-argument functions this method should return -1.

Specified by:

nargs in class AstPrimitive

str

public java.lang.String str()

Description copied from class: AstRoot

String representation of this Ast object in the Rapids language. For AstPrimitives this is the name of the function; for AstParameters this is either the name of the variable, or the value of the numeric constant that the parameter represents. For more complicated constructs such as AstExec or AstFunction this method should return those objects as a Rapids string.

Specified by:

str in class AstRoot

example

public java.lang.String example()

Description copied from class: AstRoot

Return an example of how this Ast construct ought to be used. This method is used to build documentation for the Rapids language. It is different from AstRoot.str(), in particular it must provide a valid example even in a static context. For example, an AstStr may return "Hello, world!" as an example. At the same time, for different AstPrimitives this method should generally provide a typical example of how that function is to be used.

Return null to indicate that the object should not be included in the documentation.

Overrides:

example in class AstPrimitive

description

public java.lang.String description()

Description copied from class: AstRoot

Return the detailed description (help) for what this language construct does or how it is supposed to be used. This method is used in conjunction with AstRoot.example() to build the documentation of the Rapids language.

If you need to include any formatting, then please use Markup language. Although it is up to the client to support it, Markup is one of the simplest and easiest alternatives.

Return null to indicate that the object should not be included in the documentation.

Overrides:

description in class AstPrimitive

apply

public ValNum apply(Env env,
                    Env.StackHelp stk,
                    AstRoot[] asts)

Description copied from class: AstPrimitive

Primary method to invoke this function, passing all the parameters as the `asts` list.

Specified by:

apply in class AstPrimitive

Parameters:

env - Current execution environment. Variables are looked up here.

stk - TODO need clarification

asts - List of AstRoot expressions that are arguments to the function. First element in this list is the function itself.

Returns:

value resulting from calling the function with the provided list of arguments.