io.warp10.script.formatted

Class FormattedWarpScriptFunction

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.formatted.FormattedWarpScriptFunction

All Implemented Interfaces:

WarpScriptStackFunction

Deprecated.

@Deprecated
public abstract class FormattedWarpScriptFunction
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Do the extraction of arguments from the stack in a formatted manner. Arguments inside collections still have to be handled manually. Alternatively, a Map that contains all arguments and optional arguments can be provided on top of the stack. See FormattedWarpScriptFunctionTest for an example of child class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FormattedWarpScriptFunction.Arguments Deprecated.
static class	FormattedWarpScriptFunction.ArgumentsBuilder Deprecated.

Constructor Summary

Constructors

Constructor and Description
FormattedWarpScriptFunction(java.lang.String name) Deprecated.

Method Summary

Modifier and Type	Method and Description
protected abstract WarpScriptStack	apply(java.util.Map<java.lang.String,java.lang.Object> formattedArgs, WarpScriptStack stack) Deprecated.
java.lang.Object	apply(WarpScriptStack stack) Deprecated. Create the formatted args from the signatures provided by the child class, and apply child's apply method.
protected abstract FormattedWarpScriptFunction.Arguments	getArguments() Deprecated.
protected java.lang.StringBuilder	getDocstring() Deprecated.
protected java.util.List<java.lang.String>	getUnitTests() Deprecated.

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FormattedWarpScriptFunction

public FormattedWarpScriptFunction(java.lang.String name)

Deprecated.

Method Detail

getArguments

protected abstract FormattedWarpScriptFunction.Arguments getArguments()

Deprecated.

apply

protected abstract WarpScriptStack apply(java.util.Map<java.lang.String,java.lang.Object> formattedArgs,
                                         WarpScriptStack stack)
                                  throws WarpScriptException

Deprecated.

Throws:

WarpScriptException

getDocstring

protected final java.lang.StringBuilder getDocstring()

Deprecated.

getUnitTests

protected java.util.List<java.lang.String> getUnitTests()

Deprecated.

apply

public final java.lang.Object apply(WarpScriptStack stack)
                             throws WarpScriptException

Deprecated.

Create the formatted args from the signatures provided by the child class, and apply child's apply method.

Specified by:

apply in interface WarpScriptStackFunction

Parameters:

stack -

Returns:

stack

Throws:

WarpScriptException