CollectionsFunctions (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.stdlib.function.CollectionsFunctions

public class CollectionsFunctions
extends Object

Functions for collections.

Author:: rki

Constructor Summary

Constructors
Constructor and Description

CollectionsFunctions()
Creates new instance.

Constructors
Constructor and Description
`CollectionsFunctions()` Creates new instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CollectionHolder`	`add(ExecutionContext ctx, CollectionHolder collection, Object... elements)` Returns a collection created by adding the specified element at the end of the collection.
`ListHolder`	`add(ExecutionContext ctx, ListHolder list, Object... elements)` Returns a list created by adding the specified element at the end of the list.
`MapHolder`	`add(ExecutionContext ctx, MapHolder map, Object key, Object value)` Returns a map created by adding the specified key-value pair to the map.
`SetHolder`	`add(ExecutionContext ctx, SetHolder set, Object... elements)` Returns a set created by adding the specified element to the set.
`ListHolder`	`addAll(ExecutionContext ctx, ListHolder... lists)` Deprecated. This method was used in LSPS 2.6
`ListHolder`	`addAll(ExecutionContext ctx, ListHolder list, CollectionHolder... collections)` Returns a list created as concatenation of list and collections.
`ListHolder`	`addAll(ExecutionContext ctx, ListHolder list, Decimal index, CollectionHolder... elements)` Returns a list created by adding the specified elements, given as a collections, from the position specified by index to the list.
`ListHolder`	`addAll(ExecutionContext ctx, ListHolder list, Decimal index, ListHolder... elements)` Deprecated. This method was used in LSPS 2.6
`MapHolder`	`addAll(ExecutionContext ctx, MapHolder... maps)` Returns a map created as union of maps.
`SetHolder`	`addAll(ExecutionContext ctx, SetHolder... sets)` Deprecated. This method was used in LSPS 2.6
`SetHolder`	`addAll(ExecutionContext ctx, SetHolder set, CollectionHolder... collections)` Returns a set created as concatenation of set and collections.
`SetHolder`	`addAll(ExecutionContext ctx, SetHolder set, Decimal index, CollectionHolder... elements)` Returns a set created by adding the specified elements, given as a collections, from the position specified by index to the set.
`CollectionHolder`	`addAllCollections(ExecutionContext ctx, CollectionHolder... collections)` Returns a collection created as concatenation of collections.
`CollectionHolder`	`addAllCollections(ExecutionContext ctx, CollectionHolder collection, Decimal index, CollectionHolder... elements)` Returns a collection created by adding the specified elements, given as a collections, from the position specified by index to the collection.
`CollectionHolder`	`addAt(ExecutionContext ctx, CollectionHolder collection, Decimal index, Object... elements)` Returns a collection created by adding the specified elements from the position specified by index to the collection.
`ListHolder`	`addAt(ExecutionContext ctx, ListHolder list, Decimal index, Object... elements)` Returns a list created by adding the specified elements from the position specified by index to the list.
`SetHolder`	`addAt(ExecutionContext ctx, SetHolder set, Decimal index, Object... elements)` Returns a set created by adding the specified elements from the position specified by index to the set.
`CollectionHolder`	`collect(ExecutionContext ctx, CollectionHolder collection, ClosureHolder function)` When given a collection `[a_1, a_2, ..., a_n]`, this method returns `[function(a_1), function(a_2), ..., function(a_n)]`.
`ListHolder`	`collect(ExecutionContext ctx, ListHolder list, ClosureHolder function)` When given a list `[a_1, a_2, ..., a_n]`, this method returns `[function(a_1), function(a_2), ..., function(a_n)]`.
`SetHolder`	`collect(ExecutionContext ctx, SetHolder set, ClosureHolder function)` When given a set `[a_1, a_2, ..., a_n]`, this method returns `[function(a_1), function(a_2), ..., function(a_n)]`.
`ListHolder`	`collectMap(ExecutionContext ctx, MapHolder map, ClosureHolder function)` Collects over map entries.
`CollectionHolder`	`collectWithIndex(ExecutionContext ctx, CollectionHolder collection, ClosureHolder function)` Returns a set/list/collection of values obtained by applying the function to each item of the set/list/collection.
`ListHolder`	`collectWithIndex(ExecutionContext ctx, ListHolder list, ClosureHolder function)` Returns a set/list/collection of values obtained by applying the function to each item of the set/list/collection.
`SetHolder`	`collectWithIndex(ExecutionContext ctx, SetHolder set, ClosureHolder function)` Returns a set/list/collection of values obtained by applying the function to each item of the set/list/collection.
`CollectionHolder`	`compact(ExecutionContext ctx, CollectionHolder collection)` Returns a collection containing non-null elements from a given collection.
`ListHolder`	`compact(ExecutionContext ctx, ListHolder list)` Returns a list containing non-null elements from a given list.
`SetHolder`	`compact(ExecutionContext ctx, SetHolder set)` Returns a set containing non-null elements from a given set.
`boolean`	`contains(ExecutionContext ctx, CollectionHolder collection, Object... elements)` Test method to find out whether passed collection contains element
`boolean`	`contains(ExecutionContext ctx, ListHolder list, Object... elements)` Test method to find out whether passed list contains element
`boolean`	`contains(ExecutionContext ctx, SetHolder set, Object... elements)` Test method to find out whether passed set contains element
`boolean`	`containsAll(ExecutionContext ctx, CollectionHolder collection, CollectionHolder elements)` Test method to find out whether a given collection contains all elements.
`boolean`	`containsAny(ExecutionContext ctx, CollectionHolder collection, CollectionHolder elements)` Returns `true` if the given collection contains any of the elements from the second collection.
`boolean`	`containsKeys(ExecutionContext ctx, MapHolder map, Object... keys)` Test method whether map contains key
`boolean`	`containsValues(ExecutionContext ctx, MapHolder map, Object... values)` Test method whether map contains value
`Decimal`	`count(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Counts the number of elements in the collection that fulfill the passed condition.
`ListHolder`	`difference(ExecutionContext ctx, ListHolder list, SetHolder set)` Subtracts the set from the list.
`SetHolder`	`difference(ExecutionContext ctx, SetHolder set1, SetHolder set2)` Subtracts the second set from the first set.
`boolean`	`exists(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Test whether any element in collection will fulfill passed condition
`boolean`	`exists(ExecutionContext ctx, ListHolder list, ClosureHolder condition)` Test whether any element in list will fulfill passed condition
`boolean`	`exists(ExecutionContext ctx, SetHolder set, ClosureHolder condition)` Test whether any element in list will fulfill passed condition
`Decimal`	`findIndex(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Returns the index of the first occurrence of the collection element which satisfies the specified condition; returns -1 if the condition is false for all elements of the collection.
`Decimal`	`findIndex(ExecutionContext ctx, CollectionHolder collection, Decimal fromIndex, ClosureHolder condition)` Returns the index of the first occurrence of the collection element which satisfies the specified condition, starting at `fromIndex`.
`Decimal`	`findIndex(ExecutionContext ctx, CollectionHolder collection, Decimal fromIndex, Decimal toIndex, ClosureHolder condition)` Returns the index of the first occurrence of the collection element which satisfies the specified condition, starting at `fromIndex` (inclusive) and finishing at `toIndex` (exclusive).
`Decimal`	`findLastIndex(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Returns the index of the last occurrence of the collection element which satisfies the specified condition, searching backwards; returns -1 if the condition is false for all elements of the collection.
`Decimal`	`findLastIndex(ExecutionContext ctx, CollectionHolder collection, Decimal toIndex, ClosureHolder condition)` Returns the index of the last occurrence of the collection element which satisfies the specified condition, searching backwards starting at index `toIndex - 1`; returns -1 if no such element is found.
`Decimal`	`findLastIndex(ExecutionContext ctx, CollectionHolder collection, Decimal fromIndex, Decimal toIndex, ClosureHolder condition)` Returns the index of the last occurrence of the collection element which satisfies the specified condition, searching backwards starting at index `toIndex - 1` up to `fromIndex`; returns -1 if no such element is found.
`Object`	`fold(ExecutionContext ctx, CollectionHolder collection, Object initialValue, ClosureHolder function)` Combines the elements of the collection together using the binary function, starting with the initialValue.
`Object`	`fold(ExecutionContext ctx, ListHolder list, Object initialValue, ClosureHolder function)` Combines the elements of the list together using the binary function, starting with the initialValue.
`Object`	`fold(ExecutionContext ctx, SetHolder set, Object initialValue, ClosureHolder function)` Combines the elements of the set together using the binary function, starting with the initialValue.
`Object`	`foldWithIndex(ExecutionContext ctx, CollectionHolder collection, Object initialValue, ClosureHolder function)` Combines the elements of the collection together using the binary function, starting with the initialValue.
`boolean`	`forAll(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Test whether all elements in collection will fulfill passed condition
`boolean`	`forAll(ExecutionContext ctx, ListHolder list, ClosureHolder condition)` Test whether all elements in list will fulfill passed condition
`boolean`	`forAll(ExecutionContext ctx, SetHolder set, ClosureHolder condition)` Test whether all elements in list will fulfill passed condition
`SetHolder`	`getDuplicates(ExecutionContext ctx, CollectionHolder collection)` Returns a set of element which are contained more than one time in a given collection.
`Object`	`getFirst(ExecutionContext ctx, CollectionHolder collection)` Returns the first item of the collection, or `null` if the collection is empty.
`Object`	`getFirst(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Returns the first element for which the given condition is true.
`Type`	`getItemType(ExecutionContext ctx, Type type)` Deprecated. Replaced by `TypeFunctions.getCollectionItemType(ExecutionContext, Type)`. This function is used in LSPS 3.1
`Object`	`getLast(ExecutionContext ctx, CollectionHolder collection)` Returns the last item of the collection, or `null` if the collection is empty.
`Object`	`getLast(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Returns the last element for which the given condition is true.
`MapHolder`	`groupBy(ExecutionContext ctx, CollectionHolder collection, ClosureHolder classifier)` Performs "group by".
`boolean`	`hasDuplicates(ExecutionContext ctx, CollectionHolder collection)` Returns `true` if the collection contains duplicate elements, `false` otherwise.
`Decimal`	`indexOf(ExecutionContext ctx, CollectionHolder collection, Object value)` Returns the index of the first occurrence of the specified element in the collection, or -1 if the list does not contain the element.
`Decimal`	`indexOf(ExecutionContext ctx, ListHolder list, Object value)` Returns the index of the first occurrence of the specified element in the list, or -1 if the list does not contain the element.
`boolean`	`isEmpty(ExecutionContext ctx, CollectionHolder collection)` Test method to check if collection is empty
`boolean`	`isEmpty(ExecutionContext ctx, ListHolder list)` Test method to check if list is empty
`boolean`	`isEmpty(ExecutionContext ctx, MapHolder map)` Test method to check if map is empty
`boolean`	`isEmpty(ExecutionContext ctx, SetHolder set)` Test method to check if passed set is empty
`boolean`	`isSubset(ExecutionContext ctx, SetHolder set, SetHolder set2)` Test method to find out whether set1 is subset of set2
`String`	`join(ExecutionContext ctx, CollectionHolder collection)` Joins string representations of objects in a given collection.
`String`	`join(ExecutionContext ctx, CollectionHolder collection, String joinString)` Joins string representations of objects in a given collection.
`String`	`join(ExecutionContext ctx, CollectionHolder collection, String joinString, Boolean includeEmpty)` Joins string representations of objects in a given collection.
`SetHolder`	`keys(ExecutionContext ctx, MapHolder map)` Returns a set of keys contained in the specified map.
`SetHolder`	`keysOf(ExecutionContext ctx, MapHolder map, Object value)` Returns a set of keys that are mapped to a given value.
`Decimal`	`lastIndexOf(ExecutionContext ctx, CollectionHolder collection, Object value)` Returns the index of the last occurrence of the specified element in the collection, or -1 if the collection does not contain the element.
`Decimal`	`lastIndexOf(ExecutionContext ctx, ListHolder list, Object value)` Returns the index of the last occurrence of the specified element in the list, or -1 if the list does not contain the element.
`ListHolder`	`listUnion(ExecutionContext ctx, CollectionHolder... collections)` Creates a list of all elements in the given collection of collections.
`MapHolder`	`map(ExecutionContext ctx, CollectionHolder keys, ClosureHolder valueFunction)` For each key executes a given closure to obtain a map value.
`MapHolder`	`map(ExecutionContext ctx, CollectionHolder collection, ClosureHolder keyFunction, ClosureHolder valueFunction)` For each element execute a keyFunction to obtain a map key and valueFunction to obtain a map value.
`MapHolder`	`map(ExecutionContext ctx, CollectionHolder keys, CollectionHolder values)` Creates map from collection of keys and collection of values.
`MapHolder`	`map(ExecutionContext ctx, ListHolder keys, ListHolder values)` Creates map from list of keys and list of values Each of this lists must have same size
`Object`	`max(ExecutionContext ctx, CollectionHolder collection)` Returns the maximum element from the given collection.
`Date`	`maxDate(ExecutionContext ctx, CollectionHolder collection)`
`Decimal`	`maxDecimal(ExecutionContext ctx, CollectionHolder collection)`
`Decimal`	`maxInteger(ExecutionContext ctx, CollectionHolder collection)`
`java.time.LocalDate`	`maxLocalDate(ExecutionContext ctx, CollectionHolder collection)`
`String`	`maxString(ExecutionContext ctx, CollectionHolder collection)`
`Object`	`min(ExecutionContext ctx, CollectionHolder collection)` Returns the minimum element from the given collection.
`Date`	`minDate(ExecutionContext ctx, CollectionHolder collection)`
`Decimal`	`minDecimal(ExecutionContext ctx, CollectionHolder collection)`
`Decimal`	`minInteger(ExecutionContext ctx, CollectionHolder collection)`
`java.time.LocalDate`	`minLocalDate(ExecutionContext ctx, CollectionHolder collection)`
`String`	`minString(ExecutionContext ctx, CollectionHolder collection)`
`boolean`	`notEmpty(ExecutionContext ctx, CollectionHolder collection)` Test method to check if collection is not empty.
`boolean`	`notEmpty(ExecutionContext ctx, MapHolder map)` Test method to check if map is not empty.
`CollectionHolder`	`remove(ExecutionContext ctx, CollectionHolder collection, Object... elements)` Returns a collection created by removing first occurrences of the elements from the collection.
`ListHolder`	`remove(ExecutionContext ctx, ListHolder list, Object... elements)` Returns a list created by removing first occurrences of the elements from the list.
`SetHolder`	`remove(ExecutionContext ctx, SetHolder set, Object... elements)` Returns a set created by removing first occurrences of the elements from the set.
`CollectionHolder`	`removeAll(ExecutionContext ctx, CollectionHolder collection, CollectionHolder elements)` Returns a collection created by removing all occurrences of the elements from the collection.
`ListHolder`	`removeAll(ExecutionContext ctx, ListHolder list, CollectionHolder elements)` Returns a list created by removing all occurrences of the elements from the list.
`ListHolder`	`removeAll(ExecutionContext ctx, ListHolder list, SetHolder set)` Deprecated. This method was used in LSPS 2.6
`SetHolder`	`removeAll(ExecutionContext ctx, SetHolder set, CollectionHolder elements)` Returns a set created by removing all occurrences of the elements from the set.
`SetHolder`	`removeAll(ExecutionContext ctx, SetHolder set1, SetHolder set2)` Deprecated. This method was used in LSPS 2.6
`CollectionHolder`	`removeAt(ExecutionContext ctx, CollectionHolder collection, Decimal index)` Returns a collection created by removing an element of the collection from the position specified by index.
`ListHolder`	`removeAt(ExecutionContext ctx, ListHolder list, Decimal index)` Returns a list created by removing an element of the list from the position specified by index.
`SetHolder`	`removeAt(ExecutionContext ctx, SetHolder set, Decimal index)` Returns a set created by removing an element of the set from the position specified by index.
`MapHolder`	`removeKey(ExecutionContext ctx, MapHolder map, Object... keys)` Returns a map created by removing the specified key (and its corresponding value) from the map.
`MapHolder`	`removeKeys(ExecutionContext ctx, MapHolder map, CollectionHolder keys)` Returns a map created by removing the specified keys (and the corresponding values) from the map.
`CollectionHolder`	`removeRange(ExecutionContext ctx, CollectionHolder collection, Decimal fromIndex, Decimal toIndex)` Returns a collection created by removing the specified range of elements from the given collection.
`ListHolder`	`removeRange(ExecutionContext ctx, ListHolder list, Decimal fromIndex, Decimal toIndex)` Returns a list created by removing the specified range of elements from the given list.
`SetHolder`	`removeRange(ExecutionContext ctx, SetHolder set, Decimal fromIndex, Decimal toIndex)` Returns a set created by removing the specified range of elements from the given set.
`MapHolder`	`removeValue(ExecutionContext ctx, MapHolder map, Object... values)` Returns a map created by removing all occurrences of the specified value (and their corresponding keys) from the map.
`CollectionHolder`	`replace(ExecutionContext ctx, CollectionHolder collection, Object element1, Object element2)` Returns a collection created by replacing all occurrences of the element1 by element2 in the collection.
`ListHolder`	`replace(ExecutionContext ctx, ListHolder list, Object element1, Object element2)` Returns a list created by replacing all occurrences of the element1 by element2 in the list.
`SetHolder`	`replace(ExecutionContext ctx, SetHolder set, Object element1, Object element2)` Returns a set created by replacing all occurrences of the element1 by element2 in the set.
`MapHolder`	`replaceValue(ExecutionContext ctx, MapHolder map, Object value1, Object value2)` Returns a map created by replacing all occurrences of the values corresponding to the value1 by value2 in the map.
`CollectionHolder`	`retainAll(ExecutionContext ctx, CollectionHolder collection, CollectionHolder... collections)` Returns a collection created by intersection of collections.
`ListHolder`	`retainAll(ExecutionContext ctx, ListHolder list, CollectionHolder... collections)` Returns a list created by intersection of list and all collections.
`ListHolder`	`retainAll(ExecutionContext ctx, ListHolder list, SetHolder set)` Deprecated. This method was used in LSPS 2.6
`SetHolder`	`retainAll(ExecutionContext ctx, SetHolder... sets)` Deprecated. This method was used in LSPS 2.6
`SetHolder`	`retainAll(ExecutionContext ctx, SetHolder set, CollectionHolder... collections)` Returns a set created by intersection of set and all collections.
`CollectionHolder`	`reverse(ExecutionContext ctx, CollectionHolder collection)` Returns a collection created by reversing the order of the elements in the specified collection.
`ListHolder`	`reverse(ExecutionContext ctx, ListHolder list)` Returns a list created by reversing the order of the elements in the specified list.
`SetHolder`	`reverse(ExecutionContext ctx, SetHolder set)` Returns a set created by reversing the order of the elements in the specified set.
`CollectionHolder`	`select(ExecutionContext ctx, CollectionHolder collection, ClosureHolder condition)` Returns a collection all the elements `e` from the original collection where `condition(e) == true`.
`CollectionHolder`	`select(ExecutionContext ctx, CollectionHolder collection, Type type)` Returns a collection all elements of the given type, null elements not included.
`ListHolder`	`select(ExecutionContext ctx, ListHolder list, ClosureHolder condition)` Returns a list containing all the elements `e` from the original list where `condition(e) == true`.
`ListHolder`	`select(ExecutionContext ctx, ListHolder list, Type type)` Returns a list all elements of the given type, null elements not included.
`MapHolder`	`select(ExecutionContext ctx, MapHolder map, ClosureHolder condition)` Returns a map containing all the map entries `(k,v)` from the original map where `condition(k,v) == true`.
`SetHolder`	`select(ExecutionContext ctx, SetHolder set, ClosureHolder condition)` Returns a set containing all the elements `e` from the original set where `condition(e) == true`.
`SetHolder`	`select(ExecutionContext ctx, SetHolder set, Type type)` Returns a set all elements of the given type, null elements not included.
`CollectionHolder`	`setAt(ExecutionContext ctx, CollectionHolder collection, Decimal index, Object element)` Returns a collection created by replacing the element at the position given by index in the collection with the specified element.
`ListHolder`	`setAt(ExecutionContext ctx, ListHolder list, Decimal index, Object element)` Returns a list created by replacing the element at the position given by index in the list with the specified element.
`SetHolder`	`setAt(ExecutionContext ctx, SetHolder set, Decimal index, Object element)` Returns a set created by replacing the element at the position given by index in the set with the specified element.
`Decimal`	`size(ExecutionContext ctx, CollectionHolder collection)` Return size of a given collection.
`Decimal`	`size(ExecutionContext ctx, ListHolder list)` Return size of passed list
`Decimal`	`size(ExecutionContext ctx, MapHolder map)` Return size of passed map
`Decimal`	`size(ExecutionContext ctx, SetHolder set)` Return size of SetHolder
`CollectionHolder`	`sort(ExecutionContext ctx, CollectionHolder collection, Boolean ascending)` Returns a list or set with items sorted in ascending or descending natural order.
`CollectionHolder`	`sort(ExecutionContext ctx, CollectionHolder collection, ClosureHolder comparator)` Returns items of the collection ordered according to the comparator.
`ListHolder`	`sort(ExecutionContext ctx, ListHolder list, Boolean ascending)` Returns a list with items sorted in ascending or descending natural order.
`ListHolder`	`sort(ExecutionContext ctx, ListHolder list, ClosureHolder comparator)` Returns items of the list ordered according to the comparator.
`SetHolder`	`sort(ExecutionContext ctx, SetHolder set, Boolean ascending)` Returns a set with items sorted in ascending or descending natural order.
`SetHolder`	`sort(ExecutionContext ctx, SetHolder set, ClosureHolder comparator)` Returns items of the set ordered according to the comparator.
`ListHolder`	`sortByKey(ExecutionContext ctx, CollectionHolder collection, ClosureHolder keyExtractor, Boolean ascending, Boolean nullsFirst)` Returns a list of elements sorted by keys produced by key extractor.
`CollectionHolder`	`subCollection(ExecutionContext ctx, CollectionHolder collection, Decimal fromIndex, Decimal toIndex)` Returns a collection representing such a portion of the collection, which starts from the specified fromIndex (inclusive) to the toIndex (exclusive).
`ListHolder`	`subList(ExecutionContext ctx, ListHolder list, Decimal fromIndex, Decimal toIndex)` Returns a list which represents the portion of the list between the specified fromIndex, inclusive, and toIndex, exclusive.
`SetHolder`	`subSet(ExecutionContext ctx, SetHolder set, Decimal fromIndex, Decimal toIndex)` Returns a set which represents the portion of the set between the specified fromIndex, inclusive, and toIndex, exclusive.
`Decimal`	`sum(ExecutionContext ctx, CollectionHolder collection)` Returns a sum of decimals in the given collection.
`ListHolder`	`swap(ExecutionContext ctx, ListHolder list, Decimal index1, Decimal index2)` Returns a new list of elements of original list with elements at given indexes swapped.
`ListHolder`	`toList(ExecutionContext ctx, CollectionHolder collection)` Returns a list of values contained in the set.
`ListHolder`	`toList(ExecutionContext ctx, SetHolder set)` Deprecated. This method was used in LSPS 2.6
`SetHolder`	`toSet(ExecutionContext ctx, CollectionHolder collection)` Returns a set of values contained in the collection.
`SetHolder`	`toSet(ExecutionContext ctx, ListHolder list)` Deprecated. This method was used in LSPS 2.6
`ListHolder`	`values(ExecutionContext ctx, MapHolder map)` Returns a list of values contained in the map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CollectionsFunctions
```
public CollectionsFunctions()
```
  Creates new instance.

Method Detail

map

public MapHolder map(ExecutionContext ctx,
                     CollectionHolder keys,
                     CollectionHolder values)
              throws ErrorException

Creates map from collection of keys and collection of values. The collections must have the same size.

Parameters:: ctx -; keys -; values -
Returns:: Map containing keys and values pairs
Throws:: ErrorException

map

public MapHolder map(ExecutionContext ctx,
                     CollectionHolder keys,
                     ClosureHolder valueFunction)
              throws ErrorException

For each key executes a given closure to obtain a map value.

Parameters:: ctx -; keys -; valueFunction -
Returns:: the created map
Throws:: ErrorException

map

public MapHolder map(ExecutionContext ctx,
                     CollectionHolder collection,
                     ClosureHolder keyFunction,
                     ClosureHolder valueFunction)
              throws ErrorException

For each element execute a keyFunction to obtain a map key and valueFunction to obtain a map value.

Parameters:: ctx -; collection -; keyFunction -; valueFunction -
Returns:: the created map
Throws:: ErrorException

isEmpty

public boolean isEmpty(ExecutionContext ctx,
                       MapHolder map)
                throws ErrorException

Test method to check if map is empty

Parameters:: ctx -; map -
Returns:: true if passed map is empty else returns false
Throws:: ErrorException

retainAll

public SetHolder retainAll(ExecutionContext ctx,
                           SetHolder set,
                           CollectionHolder... collections)
                    throws ErrorException

Returns a set created by intersection of set and all collections.

Parameters:: ctx -; set -; collections -
Returns:: a set created by intersection of sets
Throws:: ErrorException

retainAll

public ListHolder retainAll(ExecutionContext ctx,
                            ListHolder list,
                            CollectionHolder... collections)
                     throws ErrorException

Returns a list created by intersection of list and all collections.

Parameters:: ctx -; list -; collections -
Returns:: a list created by intersection of list and all collections
Throws:: ErrorException

retainAll

public CollectionHolder retainAll(ExecutionContext ctx,
                                  CollectionHolder collection,
                                  CollectionHolder... collections)
                           throws ErrorException

Returns a collection created by intersection of collections.

Parameters:: ctx -; collection -; collections -
Returns:: a collection created by intersection of collections
Throws:: ErrorException

difference

public SetHolder difference(ExecutionContext ctx,
                            SetHolder set1,
                            SetHolder set2)
                     throws ErrorException

Subtracts the second set from the first set.

Parameters:: ctx -; set1 - first set; set2 - second set
Returns:: a subtraction
Throws:: ErrorException

difference

public ListHolder difference(ExecutionContext ctx,
                             ListHolder list,
                             SetHolder set)
                      throws ErrorException

Subtracts the set from the list.

Parameters:: ctx -; list - a list; set - a set to subtract
Returns:: a subtraction
Throws:: ErrorException

removeAll

public ListHolder removeAll(ExecutionContext ctx,
                            ListHolder list,
                            CollectionHolder elements)
                     throws ErrorException

Returns a list created by removing all occurrences of the elements from the list.

Parameters:: ctx -; list -; elements -
Returns:: a subtraction
Throws:: ErrorException

removeAll

public SetHolder removeAll(ExecutionContext ctx,
                           SetHolder set,
                           CollectionHolder elements)
                    throws ErrorException

Returns a set created by removing all occurrences of the elements from the set.

Parameters:: ctx -; set -; elements -
Returns:: a subtraction
Throws:: ErrorException

removeAll

public CollectionHolder removeAll(ExecutionContext ctx,
                                  CollectionHolder collection,
                                  CollectionHolder elements)
                           throws ErrorException

Returns a collection created by removing all occurrences of the elements from the collection.

Parameters:: ctx -; collection -; elements -
Returns:: a subtraction
Throws:: ErrorException

remove

public ListHolder remove(ExecutionContext ctx,
                         ListHolder list,
                         Object... elements)
                  throws ErrorException

Returns a list created by removing first occurrences of the elements from the list.

Parameters:: ctx -; list -; elements -
Returns:: a subtraction
Throws:: ErrorException

remove

public SetHolder remove(ExecutionContext ctx,
                        SetHolder set,
                        Object... elements)
                 throws ErrorException

Returns a set created by removing first occurrences of the elements from the set.

Parameters:: ctx -; set -; elements -
Returns:: a subtraction
Throws:: ErrorException

remove

public CollectionHolder remove(ExecutionContext ctx,
                               CollectionHolder collection,
                               Object... elements)
                        throws ErrorException

Returns a collection created by removing first occurrences of the elements from the collection.

Parameters:: ctx -; collection -; elements -
Returns:: a subtraction
Throws:: ErrorException

removeValue

public MapHolder removeValue(ExecutionContext ctx,
                             MapHolder map,
                             Object... values)
                      throws ErrorException

Returns a map created by removing all occurrences of the specified value (and their corresponding keys) from the map.

Parameters:: ctx -; map - the map; values - values to remove
Returns:: new map
Throws:: ErrorException

removeKey

public MapHolder removeKey(ExecutionContext ctx,
                           MapHolder map,
                           Object... keys)
                    throws ErrorException

Returns a map created by removing the specified key (and its corresponding value) from the map.

Parameters:: ctx -; map - the map; keys - keys to remove
Returns:: new map
Throws:: ErrorException

removeKeys

public MapHolder removeKeys(ExecutionContext ctx,
                            MapHolder map,
                            CollectionHolder keys)
                     throws ErrorException

Returns a map created by removing the specified keys (and the corresponding values) from the map.

Parameters:: ctx -; map - the map; keys - keys to remove
Returns:: new map
Throws:: ErrorException

removeAt
```
public ListHolder removeAt(ExecutionContext ctx,
                           ListHolder list,
                           Decimal index)
                    throws ErrorException
```
Returns a list created by removing an element of the list from the position specified by index. Throws a runtime exception if the index is out of range (index < 0 or index >= size(list)).

Parameters:

ctx -

list -

index -

Returns:

a list created by removing an element of the list from the position specified by index

Throws:

ErrorException

removeAt
```
public SetHolder removeAt(ExecutionContext ctx,
                          SetHolder set,
                          Decimal index)
                   throws ErrorException
```
Returns a set created by removing an element of the set from the position specified by index. Throws a runtime exception if the index is out of range (index < 0 or index >= size(set)).

Parameters:

ctx -

set -

index -

Returns:

a set created by removing an element of the set from the position specified by index

Throws:

ErrorException

removeAt
```
public CollectionHolder removeAt(ExecutionContext ctx,
                                 CollectionHolder collection,
                                 Decimal index)
                          throws ErrorException
```
Returns a collection created by removing an element of the collection from the position specified by index. Throws a runtime exception if the index is out of range (index < 0 or index >= size(collection)).

Parameters:

ctx -

collection -

index -

Returns:

a collection created by removing an element of the collection from the position specified by index

Throws:

ErrorException

replace

public ListHolder replace(ExecutionContext ctx,
                          ListHolder list,
                          Object element1,
                          Object element2)
                   throws ErrorException

Returns a list created by replacing all occurrences of the element1 by element2 in the list.

Parameters:: ctx -; list -; element1 -; element2 -
Returns:: a list created by replacing all occurrences of the element1 by element2 in the list
Throws:: ErrorException

replace

public SetHolder replace(ExecutionContext ctx,
                         SetHolder set,
                         Object element1,
                         Object element2)
                  throws ErrorException

Returns a set created by replacing all occurrences of the element1 by element2 in the set.

Parameters:: ctx -; set -; element1 -; element2 -
Returns:: a set created by replacing all occurrences of the element1 by element2 in the set
Throws:: ErrorException

replace

public CollectionHolder replace(ExecutionContext ctx,
                                CollectionHolder collection,
                                Object element1,
                                Object element2)
                         throws ErrorException

Returns a collection created by replacing all occurrences of the element1 by element2 in the collection.

Parameters:: ctx -; collection -; element1 -; element2 -
Returns:: a collection created by replacing all occurrences of the element1 by element2 in the collection
Throws:: ErrorException

replaceValue

public MapHolder replaceValue(ExecutionContext ctx,
                              MapHolder map,
                              Object value1,
                              Object value2)
                       throws ErrorException

Returns a map created by replacing all occurrences of the values corresponding to the value1 by value2 in the map.

Parameters:: ctx -; map -; value1 -; value2 -
Returns:: a map created by replacing all occurrences of the values corresponding to the value1 by value2 in the map
Throws:: ErrorException

addAll

public SetHolder addAll(ExecutionContext ctx,
                        SetHolder set,
                        CollectionHolder... collections)
                 throws ErrorException

Returns a set created as concatenation of set and collections.

Parameters:: ctx -; set -; collections -
Returns:: new union set
Throws:: ErrorException

addAll

public ListHolder addAll(ExecutionContext ctx,
                         ListHolder list,
                         CollectionHolder... collections)
                  throws ErrorException

Returns a list created as concatenation of list and collections.

Parameters:: ctx -; list -; collections -
Returns:: concatenation
Throws:: ErrorException

addAllCollections

public CollectionHolder addAllCollections(ExecutionContext ctx,
                                          CollectionHolder... collections)
                                   throws ErrorException

Returns a collection created as concatenation of collections.

Parameters:: ctx -; collections -
Returns:: concatenation
Throws:: ErrorException

addAll
```
public ListHolder addAll(ExecutionContext ctx,
                         ListHolder list,
                         Decimal index,
                         CollectionHolder... elements)
                  throws ErrorException
```
Returns a list created by adding the specified elements, given as a collections, from the position specified by index to the list. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). The original order of the added elements is preserved also in the returned list. Throws a runtime exception if the index is out of range (index < 0 or index > size(list)).

Parameters:

ctx -

list -

index -

elements -

Returns:

a list created by adding the specified elements

Throws:

ErrorException

addAll
```
public SetHolder addAll(ExecutionContext ctx,
                        SetHolder set,
                        Decimal index,
                        CollectionHolder... elements)
                 throws ErrorException
```
Returns a set created by adding the specified elements, given as a collections, from the position specified by index to the set. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). The original order of the added elements is preserved also in the returned set. Throws a runtime exception if the index is out of range (index < 0 or index > size(set)).

Parameters:

ctx -

set -

index -

elements -

Returns:

a list created by adding the specified elements

Throws:

ErrorException

addAllCollections
```
public CollectionHolder addAllCollections(ExecutionContext ctx,
                                          CollectionHolder collection,
                                          Decimal index,
                                          CollectionHolder... elements)
                                   throws ErrorException
```
Returns a collection created by adding the specified elements, given as a collections, from the position specified by index to the collection. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). The original order of the added elements is preserved also in the returned collection. Throws a runtime exception if the index is out of range (index < 0 or index > size(collection)).

Parameters:

ctx -

collection -

index -

elements -

Returns:

a list created by adding the specified elements

Throws:

ErrorException

addAll

public MapHolder addAll(ExecutionContext ctx,
                        MapHolder... maps)
                 throws ErrorException

Returns a map created as union of maps.

Parameters:: ctx -; maps -
Returns:: map union
Throws:: ErrorException

add

public SetHolder add(ExecutionContext ctx,
                     SetHolder set,
                     Object... elements)
              throws ErrorException

Returns a set created by adding the specified element to the set.

Parameters:: ctx -; set -; elements -
Returns:: new set
Throws:: ErrorException

add

public ListHolder add(ExecutionContext ctx,
                      ListHolder list,
                      Object... elements)
               throws ErrorException

Returns a list created by adding the specified element at the end of the list.

Parameters:: ctx -; list -; elements -
Returns:: new list.
Throws:: ErrorException

add

public CollectionHolder add(ExecutionContext ctx,
                            CollectionHolder collection,
                            Object... elements)
                     throws ErrorException

Returns a collection created by adding the specified element at the end of the collection.

Parameters:: ctx -; collection -; elements -
Returns:: new list.
Throws:: ErrorException

add

public MapHolder add(ExecutionContext ctx,
                     MapHolder map,
                     Object key,
                     Object value)
              throws ErrorException

Returns a map created by adding the specified key-value pair to the map.

Parameters:: ctx -; map -; key -; value -
Returns:: new map
Throws:: ErrorException

toSet

public SetHolder toSet(ExecutionContext ctx,
                       CollectionHolder collection)
                throws ErrorException

Returns a set of values contained in the collection.

Parameters:: ctx -; collection -
Returns:: new set
Throws:: ErrorException

toList

public ListHolder toList(ExecutionContext ctx,
                         CollectionHolder collection)
                  throws ErrorException

Returns a list of values contained in the set.

Parameters:: ctx -; collection -
Returns:: new list
Throws:: ErrorException

values

public ListHolder values(ExecutionContext ctx,
                         MapHolder map)
                  throws ErrorException

Returns a list of values contained in the map.

Parameters:: ctx -; map -
Returns:: new list
Throws:: ErrorException

isEmpty

public boolean isEmpty(ExecutionContext ctx,
                       CollectionHolder collection)
                throws ErrorException

Test method to check if collection is empty

Parameters:: ctx -; collection -
Returns:: true if passed collection is empty else returns false
Throws:: ErrorException

size

public Decimal size(ExecutionContext ctx,
                    MapHolder map)
             throws ErrorException

Return size of passed map

Parameters:: ctx -; map -
Returns:: size of passed map
Throws:: ErrorException

size

public Decimal size(ExecutionContext ctx,
                    CollectionHolder collection)
             throws ErrorException

Return size of a given collection.

Parameters:: ctx -; collection -
Returns:: size of a given collection
Throws:: ErrorException

keysOf

public SetHolder keysOf(ExecutionContext ctx,
                        MapHolder map,
                        Object value)
                 throws ErrorException

Returns a set of keys that are mapped to a given value.

Parameters:: ctx -; map -; value -
Returns:: a set of keys
Throws:: ErrorException

indexOf

public Decimal indexOf(ExecutionContext ctx,
                       CollectionHolder collection,
                       Object value)
                throws ErrorException

Returns the index of the first occurrence of the specified element in the collection, or -1 if the list does not contain the element.

Parameters:: ctx -; collection -; value -
Returns:: the index of the first occurrence
Throws:: ErrorException

lastIndexOf

public Decimal lastIndexOf(ExecutionContext ctx,
                           CollectionHolder collection,
                           Object value)
                    throws ErrorException

Returns the index of the last occurrence of the specified element in the collection, or -1 if the collection does not contain the element.

Parameters:: ctx -; collection -; value -
Returns:: the index of the last occurrence
Throws:: ErrorException

containsValues

public boolean containsValues(ExecutionContext ctx,
                              MapHolder map,
                              Object... values)
                       throws ErrorException

Test method whether map contains value

Parameters:: ctx -; map -; values -
Returns:: true if map contains any mapping to passed value
Throws:: ErrorException

containsKeys

public boolean containsKeys(ExecutionContext ctx,
                            MapHolder map,
                            Object... keys)
                     throws ErrorException

Test method whether map contains key

Parameters:: ctx -; map -; keys -
Returns:: true if map contains key
Throws:: ErrorException

contains

public boolean contains(ExecutionContext ctx,
                        CollectionHolder collection,
                        Object... elements)
                 throws ErrorException

Test method to find out whether passed collection contains element

Parameters:: ctx -; collection -; elements -
Returns:: true if collection contains element else false
Throws:: ErrorException

containsAll

public boolean containsAll(ExecutionContext ctx,
                           CollectionHolder collection,
                           CollectionHolder elements)
                    throws ErrorException

Test method to find out whether a given collection contains all elements.

Parameters:: ctx -; collection -; elements -
Returns:: true if collection contains all elements else false
Throws:: ErrorException

containsAny

public boolean containsAny(ExecutionContext ctx,
                           CollectionHolder collection,
                           CollectionHolder elements)
                    throws ErrorException

Returns true if the given collection contains any of the elements from the second collection.

Parameters:: ctx -; collection -; elements -
Returns:: true if collection contains all elements else false
Throws:: ErrorException

isSubset

public boolean isSubset(ExecutionContext ctx,
                        SetHolder set,
                        SetHolder set2)
                 throws ErrorException

Test method to find out whether set1 is subset of set2

Parameters:: ctx -; set -; set2 -
Returns:: true if set1 is subset of set2, else false
Throws:: ErrorException

exists

public boolean exists(ExecutionContext ctx,
                      CollectionHolder collection,
                      ClosureHolder condition)
               throws ErrorException

Test whether any element in collection will fulfill passed condition

Parameters:: ctx -; collection -; condition -
Returns:: true if any element in passed collection fulfill condition evaluated by closure
Throws:: ErrorException

count

public Decimal count(ExecutionContext ctx,
                     CollectionHolder collection,
                     ClosureHolder condition)
              throws ErrorException

Counts the number of elements in the collection that fulfill the passed condition.

Parameters:: ctx -; collection -; condition -
Returns:: the number of elements in the collection that fulfill the passed condition
Throws:: ErrorException

keys

public SetHolder keys(ExecutionContext ctx,
                      MapHolder map)
               throws ErrorException

Returns a set of keys contained in the specified map.

Parameters:: ctx -; map -
Returns:: keys of map
Throws:: ErrorException

collect

public ListHolder collect(ExecutionContext ctx,
                          ListHolder list,
                          ClosureHolder function)
                   throws ErrorException

When given a list [a_1, a_2, ..., a_n], this method returns

[function(a_1),
 function(a_2), ..., function(a_n)]

Parameters:: ctx -; list -; function -
Returns:: [function(a_1), function(a_2), ..., function(a_n)]
Throws:: ErrorException

collect

public SetHolder collect(ExecutionContext ctx,
                         SetHolder set,
                         ClosureHolder function)
                  throws ErrorException

When given a set [a_1, a_2, ..., a_n], this method returns

[function(a_1),
 function(a_2), ..., function(a_n)]

Parameters:: ctx -; set -; function -
Returns:: [function(a_1), function(a_2), ..., function(a_n)]
Throws:: ErrorException

collect

public CollectionHolder collect(ExecutionContext ctx,
                                CollectionHolder collection,
                                ClosureHolder function)
                         throws ErrorException

When given a collection [a_1, a_2, ..., a_n], this method returns

[function(a_1),
 function(a_2), ..., function(a_n)]

Parameters:: ctx -; collection -; function -
Returns:: [function(a_1), function(a_2), ..., function(a_n)]
Throws:: ErrorException

collectMap

public ListHolder collectMap(ExecutionContext ctx,
                             MapHolder map,
                             ClosureHolder function)
                      throws ErrorException

Collects over map entries.

Parameters:: ctx -; map -; function -
Returns:: a list
Throws:: ErrorException

collectWithIndex

public ListHolder collectWithIndex(ExecutionContext ctx,
                                   ListHolder list,
                                   ClosureHolder function)
                            throws ErrorException

Returns a set/list/collection of values obtained by applying the function to each item of the set/list/collection. The function parameter takes 2 values: index of the item and the item itself.

Parameters:: ctx -; list -; function -
Returns:: a collection
Throws:: ErrorException

collectWithIndex

public SetHolder collectWithIndex(ExecutionContext ctx,
                                  SetHolder set,
                                  ClosureHolder function)
                           throws ErrorException

Returns a set/list/collection of values obtained by applying the function to each item of the set/list/collection. The function parameter takes 2 values: index of the item and the item itself.

Parameters:: ctx -; set -; function -
Returns:: a collection
Throws:: ErrorException

collectWithIndex

public CollectionHolder collectWithIndex(ExecutionContext ctx,
                                         CollectionHolder collection,
                                         ClosureHolder function)
                                  throws ErrorException

Returns a set/list/collection of values obtained by applying the function to each item of the set/list/collection. The function parameter takes 2 values: index of the item and the item itself.

Parameters:: ctx -; collection -; function -
Returns:: a collection
Throws:: ErrorException

select

public CollectionHolder select(ExecutionContext ctx,
                               CollectionHolder collection,
                               ClosureHolder condition)
                        throws ErrorException

Returns a collection all the elements e from the original collection where condition(e) == true.

Parameters:: ctx -; collection -; condition -
Returns:: a collection containing all the elements e from original collection where condition(e) == true
Throws:: ErrorException

select

public ListHolder select(ExecutionContext ctx,
                         ListHolder list,
                         ClosureHolder condition)
                  throws ErrorException

Returns a list containing all the elements e from the original list where condition(e) == true.

Parameters:: ctx -; list -; condition -
Returns:: a list containing all the elements e from original list where condition(e) == true
Throws:: ErrorException

select

public SetHolder select(ExecutionContext ctx,
                        SetHolder set,
                        ClosureHolder condition)
                 throws ErrorException

Returns a set containing all the elements e from the original set where condition(e) == true.

Parameters:: ctx -; set -; condition -
Returns:: a set containing all the elements e from original set where condition(e) == true
Throws:: ErrorException

select

public ListHolder select(ExecutionContext ctx,
                         ListHolder list,
                         Type type)
                  throws ErrorException

Returns a list all elements of the given type, null elements not included.

Parameters:: ctx -; list -; type -
Returns:: a list containing all the elements of the given type
Throws:: ErrorException

select

public SetHolder select(ExecutionContext ctx,
                        SetHolder set,
                        Type type)
                 throws ErrorException

Returns a set all elements of the given type, null elements not included.

Parameters:: ctx -; set -; type -
Returns:: a set containing all the elements of the given type
Throws:: ErrorException

select

public CollectionHolder select(ExecutionContext ctx,
                               CollectionHolder collection,
                               Type type)
                        throws ErrorException

Returns a collection all elements of the given type, null elements not included.

Parameters:: ctx -; collection -; type -
Returns:: a collection containing all the elements of the given type
Throws:: ErrorException

select
```
public MapHolder select(ExecutionContext ctx,
                        MapHolder map,
                        ClosureHolder condition)
                 throws ErrorException
```
Returns a map containing all the map entries (k,v) from the original map where condition(k,v) == true.

Parameters:

ctx -

map -

condition -

Returns:

a map containing all the map entries (k,v) from the original map where condition(k,v) == true

Throws:

ErrorException

setAt
```
public ListHolder setAt(ExecutionContext ctx,
                        ListHolder list,
                        Decimal index,
                        Object element)
                 throws ErrorException
```
Returns a list created by replacing the element at the position given by index in the list with the specified element.

Parameters:

ctx -

list -

index -

element -

Returns:

a list created by replacing the element at the position given by index in the list with the specified element

Throws:

ErrorException

NullPointerException - if list is null or index is null

IllegalArgumentException - if index is out of bounds of list

setAt
```
public SetHolder setAt(ExecutionContext ctx,
                       SetHolder set,
                       Decimal index,
                       Object element)
                throws ErrorException
```
Returns a set created by replacing the element at the position given by index in the set with the specified element.

Parameters:

ctx -

set -

index -

element -

Returns:

a set created by replacing the element at the position given by index in the set with the specified element

Throws:

ErrorException

NullPointerException - if set is null or index is null

IllegalArgumentException - if index is out of bounds of set

setAt
```
public CollectionHolder setAt(ExecutionContext ctx,
                              CollectionHolder collection,
                              Decimal index,
                              Object element)
                       throws ErrorException
```
Returns a collection created by replacing the element at the position given by index in the collection with the specified element.

Parameters:

ctx -

collection -

index -

element -

Returns:

a collection created by replacing the element at the position given by index in the collection with the specified element

Throws:

ErrorException

NullPointerException - if collection is null or index is null

IllegalArgumentException - if index is out of bounds of collection

addAt
```
public ListHolder addAt(ExecutionContext ctx,
                        ListHolder list,
                        Decimal index,
                        Object... elements)
                 throws ErrorException
```
Returns a list created by adding the specified elements from the position specified by index to the list. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). Throws a runtime exception if the index is out of range (index < 0 or index > size(list)).

Parameters:

ctx -

list -

index -

elements -

Returns:

a list created by adding the specified elements from the position specified by index to the list

Throws:

ErrorException

NullPointerException - if list of index is null

IllegalArgumentException - if index is out of bounds of list

addAt
```
public SetHolder addAt(ExecutionContext ctx,
                       SetHolder set,
                       Decimal index,
                       Object... elements)
                throws ErrorException
```
Returns a set created by adding the specified elements from the position specified by index to the set. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). Throws a runtime exception if the index is out of range (index < 0 or index > size(set)).

Parameters:

ctx -

set -

index -

elements -

Returns:

a set created by adding the specified elements from the position specified by index to the set

Throws:

ErrorException

NullPointerException - if set of index is null

IllegalArgumentException - if index is out of bounds of set

addAt
```
public CollectionHolder addAt(ExecutionContext ctx,
                              CollectionHolder collection,
                              Decimal index,
                              Object... elements)
                       throws ErrorException
```
Returns a collection created by adding the specified elements from the position specified by index to the collection. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). Throws a runtime exception if the index is out of range (index < 0 or index > size(collection)).

Parameters:

ctx -

collection -

index -

elements -

Returns:

a collection created by adding the specified elements from the position specified by index to the collection

Throws:

ErrorException

NullPointerException - if collection of index is null

IllegalArgumentException - if index is out of bounds of collection

subList
```
public ListHolder subList(ExecutionContext ctx,
                          ListHolder list,
                          Decimal fromIndex,
                          Decimal toIndex)
                   throws ErrorException
```
Returns a list which represents the portion of the list between the specified fromIndex, inclusive, and toIndex, exclusive.

Parameters:

ctx -

list -

fromIndex -

toIndex -

Returns:

a list which represents the portion of the list between the specified fromIndex, inclusive, and toIndex, exclusive

Throws:

ErrorException

subSet
```
public SetHolder subSet(ExecutionContext ctx,
                        SetHolder set,
                        Decimal fromIndex,
                        Decimal toIndex)
                 throws ErrorException
```
Returns a set which represents the portion of the set between the specified fromIndex, inclusive, and toIndex, exclusive.

Parameters:

ctx -

set -

fromIndex -

toIndex -

Returns:

a set which represents the portion of the set between the specified fromIndex, inclusive, and toIndex, exclusive

Throws:

ErrorException

subCollection
```
public CollectionHolder subCollection(ExecutionContext ctx,
                                      CollectionHolder collection,
                                      Decimal fromIndex,
                                      Decimal toIndex)
                               throws ErrorException
```
Returns a collection representing such a portion of the collection, which starts from the specified fromIndex (inclusive) to the toIndex (exclusive). If the fromIndex parameter is null or is less than 0, the sub-list starts from the beginning of the list (index 0). If the toIndex parameter is null or equal/greater than the size of the collection, the sub-collection ends at the end of the collection (index given by size(collection)-1).

Parameters:

ctx -

collection -

fromIndex -

toIndex -

Returns:

a collection which represents the portion of the collection between the specified fromIndex, inclusive, and toIndex, exclusive

Throws:

ErrorException

sort
```
public ListHolder sort(ExecutionContext ctx,
                       ListHolder list,
                       ClosureHolder comparator)
                throws ErrorException
```
Returns items of the list ordered according to the comparator. The comparator defines a total ordering function returning a negative integer, zero, or a positive integer as the first parameter is less than, equal to, or greater than the second.

Parameters:

ctx -

list -

comparator -

Returns:

list

Throws:

ErrorException

sort
```
public SetHolder sort(ExecutionContext ctx,
                      SetHolder set,
                      ClosureHolder comparator)
               throws ErrorException
```
Returns items of the set ordered according to the comparator. The comparator defines a total ordering function returning a negative integer, zero, or a positive integer as the first parameter is less than, equal to, or greater than the second.

Parameters:

ctx -

set -

comparator -

Returns:

list

Throws:

ErrorException

sort
```
public CollectionHolder sort(ExecutionContext ctx,
                             CollectionHolder collection,
                             ClosureHolder comparator)
                      throws ErrorException
```
Returns items of the collection ordered according to the comparator. The comparator defines a total ordering function returning a negative integer, zero, or a positive integer as the first parameter is less than, equal to, or greater than the second.

Parameters:

ctx -

collection -

comparator -

Returns:

list

Throws:

ErrorException

sortByKey

public ListHolder sortByKey(ExecutionContext ctx,
                            CollectionHolder collection,
                            ClosureHolder keyExtractor,
                            Boolean ascending,
                            Boolean nullsFirst)
                     throws ErrorException

Returns a list of elements sorted by keys produced by key extractor. It is assumed that keys are comparable.

Parameters:: ctx -; collection -; keyExtractor -; ascending - if true, natural order is used, if false reverse order is used; nullsFirst - if true, nulls are considered as having the lowest value, so in natural order will be the beginning
Returns:: a sorted list
Throws:: ErrorException

fold
```
public Object fold(ExecutionContext ctx,
                   CollectionHolder collection,
                   Object initialValue,
                   ClosureHolder function)
            throws ErrorException
```
Combines the elements of the collection together using the binary function, starting with the initialValue. The function is applied iteratively on the previously computed interim value and a next element of the collection. In each iteration the function computes next interim value. The last computed value represents the result of the fold function.

Parameters:

ctx -

collection -

initialValue -

function -

Returns:

The last computed value represents the result of the fold function.

Throws:

ErrorException

reverse
```
public ListHolder reverse(ExecutionContext ctx,
                          ListHolder list)
                   throws ErrorException
```
Returns a list created by reversing the order of the elements in the specified list.

Parameters:

ctx -

list -

Returns:

list created by reversing the order of the elements in the specified list.

Throws:

ErrorException

reverse
```
public SetHolder reverse(ExecutionContext ctx,
                         SetHolder set)
                  throws ErrorException
```
Returns a set created by reversing the order of the elements in the specified set.

Parameters:

ctx -

set -

Returns:

set created by reversing the order of the elements in the specified set.

Throws:

ErrorException

reverse
```
public CollectionHolder reverse(ExecutionContext ctx,
                                CollectionHolder collection)
                         throws ErrorException
```
Returns a collection created by reversing the order of the elements in the specified collection.

Parameters:

ctx -

collection -

Returns:

collection created by reversing the order of the elements in the specified collection.

Throws:

ErrorException

addAll

@Deprecated
public SetHolder addAll(ExecutionContext ctx,
                                    SetHolder... sets)
                             throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a set created as union of sets.

Parameters:: ctx -; sets -
Returns:: new union set
Throws:: ErrorException

addAll

@Deprecated
public ListHolder addAll(ExecutionContext ctx,
                                     ListHolder... lists)
                              throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a list created as concatenation of lists.

Parameters:: ctx -; lists -
Returns:: concatenation
Throws:: ErrorException

addAll
```
@Deprecated
public ListHolder addAll(ExecutionContext ctx,
                                     ListHolder list,
                                     Decimal index,
                                     ListHolder... elements)
                              throws ErrorException
```
Deprecated. This method was used in LSPS 2.6

Returns a list created by adding the specified elements, given as a list, from the position specified by index to the list. Shifts the elements currently at these positions (if any) and any subsequent elements to the right (adds the number of the added elements to their indices). The original order of the added elements is preserved also in the returned list. Throws a runtime exception if the index is out of range (index < 0 or index > size(list)).

Parameters:

ctx -

list -

index -

elements -

Returns:

a list created by adding the specified elements

Throws:

ErrorException

contains

public boolean contains(ExecutionContext ctx,
                        ListHolder list,
                        Object... elements)
                 throws ErrorException

Test method to find out whether passed list contains element

Parameters:: ctx -; list -; elements -
Returns:: true if list contains element else false
Throws:: ErrorException

contains

public boolean contains(ExecutionContext ctx,
                        SetHolder set,
                        Object... elements)
                 throws ErrorException

Test method to find out whether passed set contains element

Parameters:: ctx -; set -; elements -
Returns:: true if list contains element else false
Throws:: ErrorException

exists

public boolean exists(ExecutionContext ctx,
                      SetHolder set,
                      ClosureHolder condition)
               throws ErrorException

Test whether any element in list will fulfill passed condition

Parameters:: ctx -; set -; condition -
Returns:: true if any element in passed list fulfill condition evaluated by closure
Throws:: ErrorException

exists

public boolean exists(ExecutionContext ctx,
                      ListHolder list,
                      ClosureHolder condition)
               throws ErrorException

Test whether any element in list will fulfill passed condition

Parameters:: ctx -; list -; condition -
Returns:: true if any element in passed list fulfill condition evaluated by closure
Throws:: ErrorException

fold
```
public Object fold(ExecutionContext ctx,
                   SetHolder set,
                   Object initialValue,
                   ClosureHolder function)
            throws ErrorException
```
Combines the elements of the set together using the binary function, starting with the initialValue. The function is applied iteratively on the previously computed interim value and a next element of the set. In each iteration the function computes next interim value. The last computed value represents the result of the fold function.

Parameters:

ctx -

set -

initialValue -

function -

Returns:

The last computed value represents the result of the fold function.

Throws:

ErrorException

fold
```
public Object fold(ExecutionContext ctx,
                   ListHolder list,
                   Object initialValue,
                   ClosureHolder function)
            throws ErrorException
```
Combines the elements of the list together using the binary function, starting with the initialValue. The function is applied iteratively on the previously computed interim value and a next element of the list. In each iteration the function computes next interim value. The last computed value represents the result of the fold function.

Parameters:

ctx -

list -

initialValue -

function -

Returns:

The last computed value represents the result of the fold function.

Throws:

ErrorException

forAll

public boolean forAll(ExecutionContext ctx,
                      SetHolder set,
                      ClosureHolder condition)
               throws ErrorException

Test whether all elements in list will fulfill passed condition

Parameters:: ctx -; set -; condition -
Returns:: true if all elements in passed list fulfill condition evaluated by closure
Throws:: ErrorException

forAll

public boolean forAll(ExecutionContext ctx,
                      ListHolder list,
                      ClosureHolder condition)
               throws ErrorException

Test whether all elements in list will fulfill passed condition

Parameters:: ctx -; list -; condition -
Returns:: true if all elements in passed list fulfill condition evaluated by closure
Throws:: ErrorException

forAll

public boolean forAll(ExecutionContext ctx,
                      CollectionHolder collection,
                      ClosureHolder condition)
               throws ErrorException

Test whether all elements in collection will fulfill passed condition

Parameters:: ctx -; collection -; condition -
Returns:: true if all elements in passed collection fulfill condition evaluated by closure
Throws:: ErrorException

indexOf

public Decimal indexOf(ExecutionContext ctx,
                       ListHolder list,
                       Object value)
                throws ErrorException

Returns the index of the first occurrence of the specified element in the list, or -1 if the list does not contain the element.

Parameters:: ctx -; list -; value -
Returns:: the index of the first occurrence
Throws:: ErrorException

isEmpty

public boolean isEmpty(ExecutionContext ctx,
                       ListHolder list)
                throws ErrorException

Test method to check if list is empty

Parameters:: ctx -; list -
Returns:: true if passed list is empty else returns false
Throws:: ErrorException

isEmpty

public boolean isEmpty(ExecutionContext ctx,
                       SetHolder set)
                throws ErrorException

Test method to check if passed set is empty

Parameters:: ctx -; set -
Returns:: true if passed set is empty
Throws:: ErrorException

lastIndexOf

public Decimal lastIndexOf(ExecutionContext ctx,
                           ListHolder list,
                           Object value)
                    throws ErrorException

Returns the index of the last occurrence of the specified element in the list, or -1 if the list does not contain the element.

Parameters:: ctx -; list -; value -
Returns:: the index of the last occurrence
Throws:: ErrorException

map

public MapHolder map(ExecutionContext ctx,
                     ListHolder keys,
                     ListHolder values)
              throws ErrorException

Creates map from list of keys and list of values Each of this lists must have same size

Parameters:: ctx -; keys -; values -
Returns:: Map containing keys and values pairs
Throws:: ErrorException

removeAll

@Deprecated
public ListHolder removeAll(ExecutionContext ctx,
                                        ListHolder list,
                                        SetHolder set)
                                 throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a list created by removing all occurrences of the elements contained in the set from the list.

Parameters:: ctx -; list -; set -
Returns:: a subtraction
Throws:: ErrorException

removeAll

@Deprecated
public SetHolder removeAll(ExecutionContext ctx,
                                       SetHolder set1,
                                       SetHolder set2)
                                throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a set created by removing all occurrences of the elements contained in the set from the set.

Parameters:: ctx -; set1 -; set2 -
Returns:: a subtraction
Throws:: ErrorException

retainAll

@Deprecated
public SetHolder retainAll(ExecutionContext ctx,
                                       SetHolder... sets)
                                throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a set created by intersection of sets.

Parameters:: ctx -; sets -
Returns:: a set created by intersection of sets
Throws:: ErrorException

retainAll

@Deprecated
public ListHolder retainAll(ExecutionContext ctx,
                                        ListHolder list,
                                        SetHolder set)
                                 throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a list created by intersection of list and set.

Parameters:: ctx -; list -; set -
Returns:: a list created by intersection of list and set
Throws:: ErrorException

size

public Decimal size(ExecutionContext ctx,
                    ListHolder list)
             throws ErrorException

Return size of passed list

Parameters:: ctx -; list -
Returns:: size of list
Throws:: ErrorException

size

public Decimal size(ExecutionContext ctx,
                    SetHolder set)
             throws ErrorException

Return size of SetHolder

Parameters:: ctx -; set -
Returns:: size of SetHolder
Throws:: ErrorException

toSet

@Deprecated
public SetHolder toSet(ExecutionContext ctx,
                                   ListHolder list)
                            throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a set of values contained in the list.

Parameters:: ctx -; list -
Returns:: new set
Throws:: ErrorException

toList

@Deprecated
public ListHolder toList(ExecutionContext ctx,
                                     SetHolder set)
                              throws ErrorException

Deprecated. This method was used in LSPS 2.6

Returns a list of values contained in the set.

Parameters:: ctx -; set -
Returns:: new list
Throws:: ErrorException

getFirst
```
public Object getFirst(ExecutionContext ctx,
                       CollectionHolder collection)
                throws ErrorException
```
Returns the first item of the collection, or null if the collection is empty.

Parameters:

ctx -

collection -

Returns:

the first item of the collection, or null if the collection is empty

Throws:

ErrorException

getFirst
```
public Object getFirst(ExecutionContext ctx,
                       CollectionHolder collection,
                       ClosureHolder condition)
                throws ErrorException
```
Returns the first element for which the given condition is true. Returns null if the collection is empty or the condition is not true for all elements.

Parameters:

ctx -

collection -

condition -

Returns:

the first element satisfying the given condition

Throws:

ErrorException

getLast
```
public Object getLast(ExecutionContext ctx,
                      CollectionHolder collection)
               throws ErrorException
```
Returns the last item of the collection, or null if the collection is empty.

Parameters:

ctx -

collection -

Returns:

the last item of the collection, or null if the collection is empty

Throws:

ErrorException

getLast
```
public Object getLast(ExecutionContext ctx,
                      CollectionHolder collection,
                      ClosureHolder condition)
               throws ErrorException
```
Returns the last element for which the given condition is true. Returns null if the collection is empty or the condition is not true for all elements.

Parameters:

ctx -

collection -

condition -

Returns:

the last element satisfying the given condition

Throws:

ErrorException

findIndex
```
public Decimal findIndex(ExecutionContext ctx,
                         CollectionHolder collection,
                         ClosureHolder condition)
                  throws ErrorException
```
Returns the index of the first occurrence of the collection element which satisfies the specified condition; returns -1 if the condition is false for all elements of the collection.

Parameters:

ctx -

collection -

condition -

Returns:

the index of the first occurrence of the collection element which satisfies the specified condition or -1 if there is no such element

Throws:

ErrorException

findIndex
```
public Decimal findIndex(ExecutionContext ctx,
                         CollectionHolder collection,
                         Decimal fromIndex,
                         ClosureHolder condition)
                  throws ErrorException
```
Returns the index of the first occurrence of the collection element which satisfies the specified condition, starting at fromIndex.

Parameters:

ctx -

collection -

fromIndex -

condition -

Returns:

the index of the first occurrence of the collection element which satisfies the specified condition or -1 if there is no such element

Throws:

ErrorException

findIndex
```
public Decimal findIndex(ExecutionContext ctx,
                         CollectionHolder collection,
                         Decimal fromIndex,
                         Decimal toIndex,
                         ClosureHolder condition)
                  throws ErrorException
```
Returns the index of the first occurrence of the collection element which satisfies the specified condition, starting at fromIndex (inclusive) and finishing at toIndex (exclusive).

Parameters:

ctx -

collection -

fromIndex -

toIndex -

condition -

Returns:

the index of the first occurrence of the collection element which satisfies the specified condition or -1 if there is no such element

Throws:

ErrorException

findLastIndex
```
public Decimal findLastIndex(ExecutionContext ctx,
                             CollectionHolder collection,
                             ClosureHolder condition)
                      throws ErrorException
```
Returns the index of the last occurrence of the collection element which satisfies the specified condition, searching backwards; returns -1 if the condition is false for all elements of the collection.

Parameters:

ctx -

collection -

condition -

Returns:

the index of the last occurrence of the collection element which satisfies the specified condition or -1 if there is no such element

Throws:

ErrorException

findLastIndex
```
public Decimal findLastIndex(ExecutionContext ctx,
                             CollectionHolder collection,
                             Decimal toIndex,
                             ClosureHolder condition)
                      throws ErrorException
```
Returns the index of the last occurrence of the collection element which satisfies the specified condition, searching backwards starting at index toIndex - 1; returns -1 if no such element is found.

Parameters:

ctx -

collection -

toIndex -

condition -

Returns:

the index of the last occurrence of the collection element which satisfies the specified condition or -1 if there is no such element

Throws:

ErrorException

findLastIndex
```
public Decimal findLastIndex(ExecutionContext ctx,
                             CollectionHolder collection,
                             Decimal fromIndex,
                             Decimal toIndex,
                             ClosureHolder condition)
                      throws ErrorException
```
Returns the index of the last occurrence of the collection element which satisfies the specified condition, searching backwards starting at index toIndex - 1 up to fromIndex; returns -1 if no such element is found.

Parameters:

ctx -

collection -

fromIndex -

toIndex -

condition -

Returns:

the index of the last occurrence of the collection element which satisfies the specified condition or -1 if there is no such element

Throws:

ErrorException

sort

public ListHolder sort(ExecutionContext ctx,
                       ListHolder list,
                       Boolean ascending)
                throws ErrorException

Returns a list with items sorted in ascending or descending natural order.

Parameters:: ctx -; list -; ascending -
Returns:: a list with items sorted in ascending or descending natural order
Throws:: ErrorException

sort

public SetHolder sort(ExecutionContext ctx,
                      SetHolder set,
                      Boolean ascending)
               throws ErrorException

Returns a set with items sorted in ascending or descending natural order.

Parameters:: ctx -; set -; ascending -
Returns:: a set with items sorted in ascending or descending natural order
Throws:: ErrorException

sort

public CollectionHolder sort(ExecutionContext ctx,
                             CollectionHolder collection,
                             Boolean ascending)
                      throws ErrorException

Returns a list or set with items sorted in ascending or descending natural order.

Parameters:: ctx -; collection -; ascending -
Returns:: a list or set with items sorted in ascending or descending natural order
Throws:: ErrorException

max

public Object max(ExecutionContext ctx,
                  CollectionHolder collection)
           throws ErrorException

Returns the maximum element from the given collection.

Parameters:: ctx -; collection -
Returns:: the maximum
Throws:: ErrorException

maxDate

public Date maxDate(ExecutionContext ctx,
                    CollectionHolder collection)
             throws ErrorException

Throws:: ErrorException

maxLocalDate

public java.time.LocalDate maxLocalDate(ExecutionContext ctx,
                                        CollectionHolder collection)
                                 throws ErrorException

Throws:: ErrorException

maxDecimal

public Decimal maxDecimal(ExecutionContext ctx,
                          CollectionHolder collection)
                   throws ErrorException

Throws:: ErrorException

maxInteger

public Decimal maxInteger(ExecutionContext ctx,
                          CollectionHolder collection)
                   throws ErrorException

Throws:: ErrorException

maxString

public String maxString(ExecutionContext ctx,
                        CollectionHolder collection)
                 throws ErrorException

Throws:: ErrorException

min

public Object min(ExecutionContext ctx,
                  CollectionHolder collection)
           throws ErrorException

Returns the minimum element from the given collection.

Parameters:: ctx -; collection -
Returns:: the minimum
Throws:: ErrorException

minDate

public Date minDate(ExecutionContext ctx,
                    CollectionHolder collection)
             throws ErrorException

Throws:: ErrorException

minLocalDate

public java.time.LocalDate minLocalDate(ExecutionContext ctx,
                                        CollectionHolder collection)
                                 throws ErrorException

Throws:: ErrorException

minDecimal

public Decimal minDecimal(ExecutionContext ctx,
                          CollectionHolder collection)
                   throws ErrorException

Throws:: ErrorException

minInteger

public Decimal minInteger(ExecutionContext ctx,
                          CollectionHolder collection)
                   throws ErrorException

Throws:: ErrorException

minString

public String minString(ExecutionContext ctx,
                        CollectionHolder collection)
                 throws ErrorException

Throws:: ErrorException

notEmpty

public boolean notEmpty(ExecutionContext ctx,
                        CollectionHolder collection)
                 throws ErrorException

Test method to check if collection is not empty.

Parameters:: ctx -; collection -
Returns:: true if the given collection is not empty else returns false
Throws:: ErrorException

notEmpty

public boolean notEmpty(ExecutionContext ctx,
                        MapHolder map)
                 throws ErrorException

Test method to check if map is not empty.

Parameters:: ctx -; map -
Returns:: true if passed map is not empty else returns false
Throws:: ErrorException

removeRange

public SetHolder removeRange(ExecutionContext ctx,
                             SetHolder set,
                             Decimal fromIndex,
                             Decimal toIndex)
                      throws ErrorException

Returns a set created by removing the specified range of elements from the given set.

Parameters:: ctx -; set -; fromIndex -; toIndex -
Returns:: a set created by removing the specified range of elements from the given set
Throws:: ErrorException

removeRange

public ListHolder removeRange(ExecutionContext ctx,
                              ListHolder list,
                              Decimal fromIndex,
                              Decimal toIndex)
                       throws ErrorException

Returns a list created by removing the specified range of elements from the given list.

Parameters:: ctx -; list -; fromIndex -; toIndex -
Returns:: a list created by removing the specified range of elements from the given list
Throws:: ErrorException

removeRange

public CollectionHolder removeRange(ExecutionContext ctx,
                                    CollectionHolder collection,
                                    Decimal fromIndex,
                                    Decimal toIndex)
                             throws ErrorException

Returns a collection created by removing the specified range of elements from the given collection.

Parameters:: ctx -; collection -; fromIndex -; toIndex -
Returns:: a collection created by removing the specified range of elements from the given collection
Throws:: ErrorException

compact

public ListHolder compact(ExecutionContext ctx,
                          ListHolder list)
                   throws ErrorException

Returns a list containing non-null elements from a given list.

Parameters:: ctx -; list -
Returns:: a list containing non-null elements from a given list
Throws:: ErrorException

compact
```
public SetHolder compact(ExecutionContext ctx,
                         SetHolder set)
                  throws ErrorException
```
Returns a set containing non-null elements from a given set.

Parameters:

ctx -

set -

Returns:

a set containing non-null elements from a given set

Throws:

ErrorException

compact

public CollectionHolder compact(ExecutionContext ctx,
                                CollectionHolder collection)
                         throws ErrorException

Returns a collection containing non-null elements from a given collection.

Parameters:: ctx -; collection -
Returns:: a collection containing non-null elements from a given collection
Throws:: ErrorException

join
```
public String join(ExecutionContext ctx,
                   CollectionHolder collection)
            throws ErrorException
```
Joins string representations of objects in a given collection. Strings are separated by comma and space (", ").

Parameters:

ctx -

collection -

Returns:

a string

Throws:

ErrorException

join

public String join(ExecutionContext ctx,
                   CollectionHolder collection,
                   String joinString)
            throws ErrorException

Joins string representations of objects in a given collection.

Parameters:: ctx -; collection -; joinString -
Returns:: a string
Throws:: ErrorException

join

public String join(ExecutionContext ctx,
                   CollectionHolder collection,
                   String joinString,
                   Boolean includeEmpty)
            throws ErrorException

Joins string representations of objects in a given collection.

Parameters:: ctx -; collection -; joinString -; includeEmpty -
Returns:: a string
Throws:: ErrorException

sum

public Decimal sum(ExecutionContext ctx,
                   CollectionHolder collection)
            throws ErrorException

Returns a sum of decimals in the given collection.

Parameters:: ctx -; collection -
Returns:: a sum
Throws:: ErrorException

foldWithIndex
```
public Object foldWithIndex(ExecutionContext ctx,
                            CollectionHolder collection,
                            Object initialValue,
                            ClosureHolder function)
                     throws ErrorException
```
Combines the elements of the collection together using the binary function, starting with the initialValue. The function is applied iteratively on the previously computed interim value and a next element of the collection. In each iteration the function computes next interim value. The last computed value represents the result of the fold function.

Parameters:

ctx -

collection -

initialValue -

function -

Returns:

the last computed value

Throws:

ErrorException

listUnion

public ListHolder listUnion(ExecutionContext ctx,
                            CollectionHolder... collections)
                     throws ErrorException

Creates a list of all elements in the given collection of collections.

Parameters:: ctx -; collections -
Returns:: a list of all elements
Throws:: ErrorException

getDuplicates

public SetHolder getDuplicates(ExecutionContext ctx,
                               CollectionHolder collection)
                        throws ErrorException

Returns a set of element which are contained more than one time in a given collection.

Parameters:: ctx -; collection -
Returns:: a set of duplicates
Throws:: ErrorException

hasDuplicates

public boolean hasDuplicates(ExecutionContext ctx,
                             CollectionHolder collection)
                      throws ErrorException

Returns true if the collection contains duplicate elements, false otherwise.

Parameters:: ctx -; collection -
Returns:: true if the collection contains duplicate elements
Throws:: ErrorException

getItemType
```
@Deprecated
public Type getItemType(ExecutionContext ctx,
                                    Type type)
```
Deprecated. Replaced by TypeFunctions.getCollectionItemType(ExecutionContext, Type). This function is used in LSPS 3.1

Parameters:

ctx -

type -

Returns:

the collection item type

swap

public ListHolder swap(ExecutionContext ctx,
                       ListHolder list,
                       Decimal index1,
                       Decimal index2)
                throws ErrorException

Returns a new list of elements of original list with elements at given indexes swapped.

Parameters:: ctx -; list -; index1 -; index2 -
Returns:: a new list of elements at given indexes swapped
Throws:: ErrorException

groupBy

public MapHolder groupBy(ExecutionContext ctx,
                         CollectionHolder collection,
                         ClosureHolder classifier)
                  throws ErrorException

Performs "group by".

Parameters:: ctx -; collection -; classifier -
Returns:: a result map
Throws:: ErrorException

Class CollectionsFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CollectionsFunctions

Method Detail

map

map

map

isEmpty

retainAll

retainAll

retainAll

difference

difference

removeAll

removeAll

removeAll

remove

remove

remove

removeValue

removeKey

removeKeys

removeAt

removeAt

removeAt

replace

replace

replace

replaceValue

addAll

addAll

addAllCollections

addAll

addAll

addAllCollections

addAll

add

add

add

add

toSet

toList

values

isEmpty

size

size

keysOf

indexOf

lastIndexOf

containsValues

containsKeys

contains

containsAll

containsAny

isSubset

exists

count

keys

collect

collect

collect

collectMap

collectWithIndex

collectWithIndex

collectWithIndex

select

select

select

select

select

select

select

setAt

setAt

setAt

addAt

addAt