groovy.util.GroovyCollections Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of groovy Show documentation
Show all versions of groovy Show documentation
Groovy: A powerful multi-faceted language for the JVM
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package groovy.util;
import groovy.lang.Closure;
import groovy.transform.stc.ClosureParams;
import groovy.transform.stc.FromString;
import org.codehaus.groovy.runtime.DefaultGroovyMethods;
import org.codehaus.groovy.runtime.NumberAwareComparator;
import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
/**
* A Collections utility class
*/
public class GroovyCollections {
/**
* Finds all combinations of items from the given collections.
*
* @param collections the given collections
* @return a List of the combinations found
* @see #combinations(Iterable)
*/
public static List combinations(Object[] collections) {
return combinations(Arrays.asList(collections));
}
/**
* 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]]
*
* @param items the List of items
* @return the subsequences from items
*/
public static Set> subsequences(List items) {
// items.inject([]){ ss, h -> ss.collect { it + [h] } + ss + [[h]] }
Set> ans = new HashSet<>();
for (T h : items) {
Set> next = new HashSet<>();
for (List it : ans) {
List sublist = new ArrayList<>(it);
sublist.add(h);
next.add(sublist);
}
next.addAll(ans);
List hlist = new ArrayList<>();
hlist.add(h);
next.add(hlist);
ans = next;
}
return ans;
}
/**
* 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.
*
* @param collections the Iterable of given collections
* @return a List of the combinations found
* @since 2.2.0
*/
public static List combinations(Iterable collections) {
List collectedCombos = new ArrayList();
for (Object collection : collections) {
Iterable items = DefaultTypeTransformation.asCollection(collection);
if (collectedCombos.isEmpty()) {
for (Object item : items) {
List l = new ArrayList();
l.add(item);
collectedCombos.add(l);
}
} else {
List savedCombos = new ArrayList(collectedCombos);
List newCombos = new ArrayList();
for (Object value : items) {
for (Object savedCombo : savedCombos) {
List oldList = new ArrayList((List) savedCombo);
oldList.add(value);
newCombos.add(oldList);
}
}
collectedCombos = newCombos;
}
if (collectedCombos.isEmpty())
break;
}
return collectedCombos;
}
public static List> inits(Iterable collections) {
List copy = DefaultGroovyMethods.toList(collections);
List> result = new ArrayList<>();
for (int i = copy.size(); i >= 0; i--) {
List next = copy.subList(0, i);
result.add(next);
}
return result;
}
public static List> tails(Iterable collections) {
List copy = DefaultGroovyMethods.toList(collections);
List> result = new ArrayList<>();
for (int i = 0; i <= copy.size(); i++) {
List next = copy.subList(i, copy.size());
result.add(next);
}
return result;
}
/**
* Transposes an array of lists.
*
* @param lists the given lists
* @return a List of the transposed lists
* @see #transpose(List)
*/
public static List transpose(Object[] lists) {
return transpose(Arrays.asList(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']].
*
* @param lists the given lists
* @return a List of the transposed lists
*/
public static List transpose(List lists) {
List result = new ArrayList();
if (lists.isEmpty()) return result;
int minSize = Integer.MAX_VALUE;
for (Object listLike : lists) {
List list = (List) DefaultTypeTransformation.castToType(listLike, List.class);
if (list.size() < minSize) minSize = list.size();
}
if (minSize == 0) return result;
for (int i = 0; i < minSize; i++) {
result.add(new ArrayList());
}
for (Object listLike : lists) {
List list = (List) DefaultTypeTransformation.castToType(listLike, List.class);
for (int i = 0; i < minSize; i++) {
List resultList = (List) result.get(i);
resultList.add(list.get(i));
}
}
return result;
}
/**
* Selects the minimum value found in an array of items, so
* min([2, 4, 6] as Object[]) == 2.
*
* @param items an array of items
* @return the minimum value
*/
public static T min(T[] items) {
return DefaultGroovyMethods.min(items);
}
/**
* Selects the minimum value found in an Iterable of items.
*
* @param items an Iterable
* @return the minimum value
* @since 2.2.0
*/
public static T min(Iterable items) {
return DefaultGroovyMethods.min(items);
}
/**
* Selects the maximum value found in an array of items, so
* max([2, 4, 6] as Object[]) == 6.
*
* @param items an array of items
* @return the maximum value
*/
public static T max(T[] items) {
return DefaultGroovyMethods.max(items);
}
/**
* Selects the maximum value found in an Iterable.
*
* @param items a Collection
* @return the maximum value
* @since 2.2.0
*/
public static T max(Iterable items) {
return DefaultGroovyMethods.max(items);
}
/**
* Sums all the items from an array of items.
*
* @param items an array of items
* @return the sum of the items
*/
public static Object sum(Object[] items) {
return DefaultGroovyMethods.sum(items);
}
/**
* Sums all the given items.
*
* @param items an Iterable of items
* @return the sum of the item
* @since 2.2.0
*/
public static Object sum(Iterable items) {
return DefaultGroovyMethods.sum(items);
}
/**
* Returns an ordered set of all the unique items found in the provided argument iterables.
*
* assert GroovyCollections.union([1, 2], [2, 3], [1, 4]) == [1, 2, 3, 4]
*
*
* @param iterables the sources of items
* @return the ordered list of unique values found
* @since 4.0.0
*/
public static List union(Iterable... iterables) {
return union(Arrays.asList(iterables));
}
/**
* Returns an ordered set of all the unique items found in the provided argument iterables.
*
* assert GroovyCollections.union([[1, 2], [2, 3], [1, 4]]) == [1, 2, 3, 4]
*
*
* @param iterables the list of source items
* @return the ordered list of unique values found
* @since 4.0.0
*/
public static List union(List> iterables) {
return union(iterables, new NumberAwareComparator<>());
}
/**
* Returns an ordered set of all the unique items found in the provided argument iterables
* using the provided comparator to compare items.
*
* assert GroovyCollections.union(n -> n.abs(), [1, 2, 5], [-3, -4, -5], [4, 6]) == [1, 2, 5, -3, -4, 6]
* assert GroovyCollections.union(n -> n.trunc(), [1.1, 2.2], [2.5, 3.3], [3.9, 4.1]) == [1.1, 2.2, 3.3, 4.1]
* assert GroovyCollections.union(w -> w.toUpperCase(), ['a', 'A'], ['B', 'a', 'c', 'b']) == ['a', 'B', 'c']
*
*
* @param comparator a Comparator
* @param iterables the sources of items
* @return the ordered list of unique values found
* @since 4.0.0
*/
public static List union(Comparator comparator, Iterable... iterables) {
return union(Arrays.asList(iterables), comparator);
}
/**
* Returns an ordered set of all the unique items found in the provided argument iterables
* using the provided comparator to compare items.
*
* assert GroovyCollections.union([[1, 2, 5], [-3, -4, -5], [4, 6]], n -> n.abs()) == [1, 2, 5, -3, -4, 6]
* assert GroovyCollections.union([[1.1, 2.2], [2.5, 3.3], [3.9, 4.1]], n -> n.trunc()) == [1.1, 2.2, 3.3, 4.1]
* assert GroovyCollections.union([['a', 'A'], ['B', 'a', 'c', 'b']], w -> w.toUpperCase()) == ['a', 'B', 'c']
*
*
* @param iterables the list of source items
* @param comparator a Comparator
* @return the ordered list of unique values found
* @since 4.0.0
*/
public static List union(List> iterables, Comparator comparator) {
LinkedHashSet ansSet = new LinkedHashSet<>();
TreeSet seen = new TreeSet<>(comparator);
for (Iterable nextList : iterables) {
for (T next : nextList) {
if (seen.add(next)) {
ansSet.add(next);
}
}
}
return new ArrayList<>(ansSet);
}
/**
* Returns an ordered set of all the unique items found in the provided argument iterables
* using the provided closure to compare items.
*
* def abs = { n -> n.abs() }
* assert GroovyCollections.union(abs, [1, 2, 5], [-3, -4, -5], [4, 6]) == [1, 2, 5, -3, -4, 6]
*
*
* @param condition a Closure used to determine unique items
* @param iterables the sources of items
* @return the ordered list of unique values found
* @since 4.0.0
*/
public static List union(@ClosureParams(value= FromString.class, options={"T","T,T"}) Closure condition, Iterable... iterables) {
return union(Arrays.asList(iterables), condition);
}
/**
* Returns an ordered set of all the unique items found in the provided argument iterables
* using the provided closure to compare items.
*
* assert GroovyCollections.union([[1, 2, 5], [-3, -4, -5], [4, 6]]){ n -> n.abs() } == [1, 2, 5, -3, -4, 6]
*
*
* @param iterables the list of source items
* @param condition a Closure used to determine unique items
* @return the ordered list of unique values found
* @since 4.0.0
*/
public static List union(List> iterables, @ClosureParams(value= FromString.class, options={"T","T,T"}) Closure condition) {
Comparator comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<>(condition, true)
: new ClosureComparator<>(condition);
return union(iterables, comparator);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy