water.rapids.ast

Class AstParameter

java.lang.Object

water.Iced<T>

water.rapids.ast.AstRoot

water.rapids.ast.AstParameter

All Implemented Interfaces:

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

Direct Known Subclasses:

AstConst, AstId, AstNum, AstNumList, AstStr, AstStrList

public abstract class AstParameter
extends AstRoot

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AstParameter()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	columns(java.lang.String[] 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.
java.lang.String	toJavaString()

Methods inherited from class water.rapids.ast.AstRoot

exec, str, toString

Methods inherited from class water.Iced

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AstParameter

public AstParameter()

Method Detail

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.

Specified by:

example in class AstRoot

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.

Specified by:

description in class AstRoot

toJavaString

public java.lang.String toJavaString()

columns

public int[] columns(java.lang.String[] names)