Apache Groovy 3.0.20 · groovy.util.GroovyCollections

Access	Constructor and Description
public	GroovyCollections()

Method Summary

Modifier and Type	Method and Description
public static List<E>	Returns: a List of the combinations found combinations(Object[] the given collections collections) Finds all combinations of items from the given collections.
public static List<E>	combinations(Collection<E> the given collections collections) Deprecated use combinations(Iterable)
public static List<E>	Returns: a List of the combinations found combinations(Iterable<T> the Iterable of given collections collections) Finds all combinations of items from the given Iterable aggregate of collections.
public static <T> List<List<T>>	inits(Iterable<T> collections)
public static <T> T	Returns: the maximum value max(T[] an array of items items) Selects the maximum value found in an array of items, so max([2, 4, 6] as Object[]) == 6.
public static <T> T	max(Collection<T> items) Deprecated use max(Iterable)
public static <T> T	Returns: the maximum value max(Iterable<T> a Collection items) Selects the maximum value found in an Iterable.
public static <T> T	Returns: the minimum value min(T[] an array of items items) Selects the minimum value found in an array of items, so min([2, 4, 6] as Object[]) == 2.
public static <T> T	min(Collection<T> items) Deprecated use min(Iterable)
public static <T> T	Returns: the minimum value min(Iterable<T> an Iterable items) Selects the minimum value found in an Iterable of items.
public static <T> Set<List<T>>	Returns: the subsequences from items subsequences(List<T> the List of items items) Finds all non-null subsequences of a list.
public static Object	Returns: the sum of the items sum(Object[] an array of items items) Sums all the items from an array of items.
public static Object	sum(Collection<E> items) Deprecated use sum(Iterable)
public static Object	Returns: the sum of the item sum(Iterable<?> an Iterable of items items) Sums all the given items.
public static <T> List<List<T>>	tails(Iterable<T> collections)
public static List<E>	Returns: a List of the transposed lists transpose(Object[] the given lists lists) Transposes an array of lists.
public static List<E>	Returns: a List of the transposed lists transpose(List<E> the given lists lists) Transposes the given lists.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

GroovyCollections	back to summary
public GroovyCollections()

Method Detail

combinations back to summary

combinations	back to summary
public static List<E> combinations(Object[] collections) Finds all combinations of items from the given collections. Parameters collections:Object[] the given collections Returns:List<E> a List of the combinations found See Also `combinations(Collection)`

public static List<E> combinations(Object[] collections)

Finds all combinations of items from the given collections.

Parameters

collections:Object[]: the given collections

Returns:List<E>

a List of the combinations found

See Also

combinations(Collection)

combinations	back to summary
public static List<E> combinations(Collection<E> collections) Deprecated use combinations(Iterable) Parameters collections:Collection<E> the given collections Annotations @Deprecated

combinations back to summary

combinations	back to summary
public static List<E> combinations(Iterable<T> collections) Finds all combinations of items from the given Iterable aggregate of collections. So, `combinations([[true, false], [true, false]])` is `[[true, true], [false, true], [true, false], [false, false]]` and `combinations([['a', 'b'],[1, 2, 3]])` is `[['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]`. If a non-collection item is given, it is treated as a singleton collection, i.e. `combinations([[1, 2], 'x'])` is `[[1, 'x'], [2, 'x']]`. If an empty collection is found within the given collections, the result will be an empty list. Parameters collections:Iterable<T> the Iterable of given collections Returns:List<E> a List of the combinations found Since 2.2.0

public static List<E> combinations(Iterable<T> collections)

Finds all combinations of items from the given Iterable aggregate of collections. So, combinations([[true, false], [true, false]]) is [[true, true], [false, true], [true, false], [false, false]] and combinations([['a', 'b'],[1, 2, 3]]) is [['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]. If a non-collection item is given, it is treated as a singleton collection, i.e. combinations([[1, 2], 'x']) is [[1, 'x'], [2, 'x']]. If an empty collection is found within the given collections, the result will be an empty list.

Parameters

collections:Iterable<T>: the Iterable of given collections

Returns:List<E>

a List of the combinations found

Since

2.2.0

inits	back to summary
public static <T> List<List<T>> inits(Iterable<T> collections)

max	back to summary
public static <T> T max(T[] items) Selects the maximum value found in an array of items, so max([2, 4, 6] as Object[]) == 6. Parameters items:T[] an array of items Returns:T the maximum value

max

back to summary

public static <T> T max(T[] items)

Selects the maximum value found in an array of items, so max([2, 4, 6] as Object[]) == 6.

Parameters

items:T[]: an array of items

Returns:T

the maximum value

max	back to summary
public static <T> T max(Collection<T> items) Deprecated use max(Iterable) Annotations @Deprecated

max	back to summary
public static <T> T max(Iterable<T> items) Selects the maximum value found in an Iterable. Parameters items:Iterable<T> a Collection Returns:T the maximum value Since 2.2.0

max

back to summary

public static <T> T max(Iterable<T> items)

Selects the maximum value found in an Iterable.

Parameters

items:Iterable<T>: a Collection

Returns:T

the maximum value

Since

2.2.0

min	back to summary
public static <T> T min(T[] items) Selects the minimum value found in an array of items, so min([2, 4, 6] as Object[]) == 2. Parameters items:T[] an array of items Returns:T the minimum value

min

back to summary

public static <T> T min(T[] items)

Selects the minimum value found in an array of items, so min([2, 4, 6] as Object[]) == 2.

Parameters

items:T[]: an array of items

Returns:T

the minimum value

min	back to summary
public static <T> T min(Collection<T> items) Deprecated use min(Iterable) Annotations @Deprecated

min	back to summary
public static <T> T min(Iterable<T> items) Selects the minimum value found in an Iterable of items. Parameters items:Iterable<T> an Iterable Returns:T the minimum value Since 2.2.0

min

back to summary

public static <T> T min(Iterable<T> items)

Selects the minimum value found in an Iterable of items.

Parameters

items:Iterable<T>: an Iterable

Returns:T

the minimum value

Since

2.2.0

subsequences back to summary

subsequences	back to summary
public static <T> Set<List<T>> subsequences(List<T> items) Finds all non-null subsequences of a list. E.g. `subsequences([1, 2, 3])` would be: [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] Parameters items:List<T> the List of items Returns:Set<List<T>> the subsequences from items

public static <T> Set<List<T>> subsequences(List<T> items)

Finds all non-null subsequences of a list. E.g. subsequences([1, 2, 3]) would be: [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]]

Parameters

items:List<T>: the List of items

Returns:Set<List<T>>

the subsequences from items

sum	back to summary
public static Object sum(Object[] items) Sums all the items from an array of items. Parameters items:Object[] an array of items Returns:Object the sum of the items

sum

back to summary

public static Object sum(Object[] items)

Sums all the items from an array of items.

Parameters

items:Object[]: an array of items

Returns:Object

the sum of the items

sum	back to summary
public static Object sum(Collection<E> items) Deprecated use sum(Iterable) Annotations @Deprecated

sum	back to summary
public static Object sum(Iterable<?> items) Sums all the given items. Parameters items:Iterable<?> an Iterable of items Returns:Object the sum of the item Since 2.2.0

sum

back to summary

public static Object sum(Iterable<?> items)

Sums all the given items.

Parameters

items:Iterable<?>: an Iterable of items

Returns:Object

the sum of the item

Since

2.2.0

tails	back to summary
public static <T> List<List<T>> tails(Iterable<T> collections)

transpose back to summary

transpose	back to summary
public static List<E> transpose(Object[] lists) Transposes an array of lists. Parameters lists:Object[] the given lists Returns:List<E> a List of the transposed lists See Also `transpose(List)`

public static List<E> transpose(Object[] lists)

Transposes an array of lists.

Parameters

lists:Object[]: the given lists

Returns:List<E>

a List of the transposed lists

See Also

transpose(List)

transpose back to summary

transpose	back to summary
public static List<E> transpose(List<E> lists) Transposes the given lists. So, `transpose([['a', 'b'], [1, 2]])` is `[['a', 1], ['b', 2]]` and `transpose([['a', 'b', 'c']])` is `[['a'], ['b'], ['c']]`. Parameters lists:List<E> the given lists Returns:List<E> a List of the transposed lists

public static List<E> transpose(List<E> lists)

Transposes the given lists. So, transpose([['a', 'b'], [1, 2]]) is [['a', 1], ['b', 2]] and transpose([['a', 'b', 'c']]) is [['a'], ['b'], ['c']].

Parameters

lists:List<E>: the given lists

Returns:List<E>

a List of the transposed lists

public Class GroovyCollections

Constructor Summary

Method Summary

Constructor Detail

Method Detail