io.warp10.script.functions

Class GET

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.functions.GET

All Implemented Interfaces:

WarpScriptStackFunction

public class GET
extends NamedWarpScriptFunction
implements WarpScriptStackFunction

Extracts a value from a map, list, a byte array or a String, given a key.

Constructor Summary

Constructors

Constructor and Description
GET(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(WarpScriptStack stack)
static int	computeAndCheckIndex(int index, int size)
static java.lang.Object	get(java.lang.Object key, java.lang.Object collection) Get a value from a List, Map, byte[] or String using respectively a Long, Object, Long or Long key.
static java.lang.Object	nestedGet(java.util.List<java.lang.Object> nestedList, java.util.List<java.lang.Long> indexList)

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

GET

public GET(java.lang.String name)

Method Detail

apply

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

Specified by:

apply in interface WarpScriptStackFunction

Throws:

WarpScriptException

get

public static java.lang.Object get(java.lang.Object key,
                                   java.lang.Object collection)
                            throws WarpScriptException

Get a value from a List, Map, byte[] or String using respectively a Long, Object, Long or Long key.

Parameters:

key - Either an Object for a Map or a Long for List, byte[] or String. Negative indexing is possible, in that case the corresponding index is size + index.

collection - Either a List, Map, byte[] or String instance.

Returns:

The value at the given key.

Throws:

WarpScriptException - If the collection type cannot be handled or the key is invalid for the collection type.

computeAndCheckIndex

public static int computeAndCheckIndex(int index,
                                       int size)
                                throws WarpScriptException

Throws:

WarpScriptException

nestedGet

public static java.lang.Object nestedGet(java.util.List<java.lang.Object> nestedList,
                                         java.util.List<java.lang.Long> indexList)
                                  throws WarpScriptException

Throws:

WarpScriptException