io.warp10.script.functions

Class WRAP

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.ElementOrListStackFunction

io.warp10.script.functions.WRAP

All Implemented Interfaces:

WarpScriptStackFunction

public class WRAP
extends ElementOrListStackFunction

Wrap GTS or Encoders into GTSWrappers

Nested Class Summary

Nested classes/interfaces inherited from class io.warp10.script.ElementOrListStackFunction

ElementOrListStackFunction.ElementStackFunction

Constructor Summary

Constructors

Constructor and Description
WRAP(java.lang.String name)
WRAP(java.lang.String name, boolean opt)
WRAP(java.lang.String name, boolean opt, boolean compress)
WRAP(java.lang.String name, boolean opt, boolean compress, boolean raw)
WRAP(java.lang.String name, boolean opt, boolean compress, boolean raw, boolean mv)

Method Summary

Modifier and Type	Method and Description
ElementOrListStackFunction.ElementStackFunction	generateFunction(WarpScriptStack stack) Generates the function to be applied on the element(s) using the parameters on the stack.

Methods inherited from class io.warp10.script.ElementOrListStackFunction

apply

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

WRAP

public WRAP(java.lang.String name)

WRAP

public WRAP(java.lang.String name,
            boolean opt)

WRAP

public WRAP(java.lang.String name,
            boolean opt,
            boolean compress)

WRAP

public WRAP(java.lang.String name,
            boolean opt,
            boolean compress,
            boolean raw)

WRAP

public WRAP(java.lang.String name,
            boolean opt,
            boolean compress,
            boolean raw,
            boolean mv)

Method Detail

generateFunction

public ElementOrListStackFunction.ElementStackFunction generateFunction(WarpScriptStack stack)
                                                                 throws WarpScriptException

Description copied from class: ElementOrListStackFunction

Generates the function to be applied on the element(s) using the parameters on the stack.

Specified by:

generateFunction in class ElementOrListStackFunction

Parameters:

stack - The stack to be used for parameters retrieval.

Returns:

An ElementStackFunction which will be applied on each given elements or on the given element.

Throws:

WarpScriptException