Groovy 2.2.1

groovy.util
[Java] Class GroovyCollections

java.lang.Object
  groovy.util.GroovyCollections

public class GroovyCollections
extends Object

A Collections utility class

Authors:
Paul King
Jim White


Method Summary
static List combinations(Object[] collections)

Finds all combinations of items from the given collections.

static List combinations(Collection collections)

@param collections the given collections

static List combinations(Iterable collections)

Finds all combinations of items from the given Iterable aggregate of collections.

static Object max(Object[] items)

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

static Object max(Collection items)

@deprecated use max(Iterable)

static Object max(Iterable items)

Selects the maximum value found in an Iterable.

static Object min(Object[] items)

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

static Object min(Collection items)

@deprecated use min(Iterable)

static Object min(Iterable items)

Selects the minimum value found in an Iterable of items.

static Set subsequences(List items)

Finds all non-null subsequences of a list.

static Object sum(Object[] items)

Sums all the items from an array of items.

static Object sum(Collection items)

@deprecated use sum(Iterable)

static Object sum(Iterable items)

Sums all the given items.

static List transpose(Object[] lists)

Transposes an array of lists.

static List transpose(List lists)

Transposes the given lists.

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Method Detail

combinations

public static List combinations(Object[] collections)
Finds all combinations of items from the given collections.
Parameters:
collections - the given collections
Returns:
a List of the combinations found
See Also:
combinations(Collection)


combinations

@Deprecatedpublic static List combinations(Collection collections) {
public static List combinations(Collection collections)
deprecated:
use combinations(Iterable)
Parameters:
collections - the given collections


combinations

public static List combinations(Iterable 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']].
Parameters:
collections - the Iterable of given collections
Returns:
a List of the combinations found
Since:
2.2.0


max

public static Object max(Object[] items)
Selects the maximum value found in an array of items, so min([2, 4, 6] as Object[]) == 6.
Parameters:
items - an array of items
Returns:
the maximum value


max

@Deprecatedpublic static  T max(Collection items) {
public static Object max(Collection items)
deprecated:
use max(Iterable)


max

public static Object max(Iterable items)
Selects the maximum value found in an Iterable.
Parameters:
items - a Collection
Returns:
the maximum value
Since:
2.2.0


min

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


min

@Deprecatedpublic static  T min(Collection items) {
public static Object min(Collection items)
deprecated:
use min(Iterable)


min

public static Object min(Iterable items)
Selects the minimum value found in an Iterable of items.
Parameters:
items - an Iterable
Returns:
the minimum value
Since:
2.2.0


subsequences

public static Set subsequences(List 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 - the List of items
Returns:
the subsequences from items


sum

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


sum

@Deprecatedpublic static Object sum(Collection items) {
public static Object sum(Collection items)
deprecated:
use sum(Iterable)


sum

public static Object sum(Iterable items)
Sums all the given items.
Parameters:
items - an Iterable of items
Returns:
the sum of the item
Since:
2.2.0


transpose

public static List transpose(Object[] lists)
Transposes an array of lists.
Parameters:
lists - the given lists
Returns:
a List of the transposed lists
See Also:
transpose(List)


transpose

public static List transpose(List 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 - the given lists
Returns:
a List of the transposed lists


 

Copyright © 2003-2013 The Codehaus. All rights reserved.