Package org.gradle.util
Class CollectionUtils
java.lang.Object
org.gradle.util.CollectionUtils
Deprecated.
Will be removed in Gradle 9.0.
This class is only here to maintain binary compatibility with existing plugins.
 
 Plugins should prefer external collection frameworks over this class.
 Internally, all code should use CollectionUtils.
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classDeprecated.static classDeprecated.The result of diffing two sets.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic <T,C extends Collection<? super T>> 
 CDeprecated.Utility for adding an iterable to a collection.static <T,C extends Collection<? super T>> 
 CaddAll(C t1, T... t2) Deprecated.Utility for adding an array to a collection.static <T> booleanDeprecated.static <T> booleanDeprecated.static StringasCommandLine(Iterable<String> arguments) Deprecated.static <T> Collection<? extends T> checkedCast(Class<T> type, Collection<?> input) Deprecated.static <R,I> List <R> collect(I[] list, Transformer<? extends R, ? super I> transformer) Deprecated.static <R,I, C extends Collection<R>> 
 Ccollect(Iterable<? extends I> source, C destination, Transformer<? extends R, ? super I> transformer) Deprecated.static <R,I> List <R> collect(Iterable<? extends I> source, Transformer<? extends R, ? super I> transformer) Deprecated.static <R,I> Set <R> collect(Set<? extends I> set, Transformer<? extends R, ? super I> transformer) Deprecated.static <R,I> R[] collectArray(I[] list, Class<R> newType, Transformer<? extends R, ? super I> transformer) Deprecated.static <R,I> R[] collectArray(I[] list, R[] destination, Transformer<? extends R, ? super I> transformer) Deprecated.static <K,V> Map <K, V> collectMap(Iterable<? extends V> items, Transformer<? extends K, ? super V> keyGenerator) Deprecated.Given a set of values, derive a set of keys and return a mapstatic <K,V> void collectMap(Map<K, V> destination, Iterable<? extends V> items, Transformer<? extends K, ? super V> keyGenerator) Deprecated.static <K,V> Map <K, V> collectMapValues(Iterable<? extends K> keys, Transformer<? extends V, ? super K> keyGenerator) Deprecated.Given a set of keys, derive a set of values and return a mapstatic <K,V> void collectMapValues(Map<K, V> destination, Iterable<? extends K> keys, Transformer<? extends V, ? super K> keyGenerator) Deprecated.static <E> List<E> Deprecated.static <T> CollectionUtils.SetDiff<T> diffSetsBy(Set<? extends T> left, Set<? extends T> right, Transformer<?, T> compareBy) Deprecated.Provides a "diff report" of how the two sets are similar and how they are different, comparing the entries by some aspect.static <T> booleanDeprecated.static <T,C extends Collection<T>> 
 CDeprecated.static <T> List<T> Deprecated.static <K,V> Map <K, V> Deprecated.static <K,V> Map <K, V> Deprecated.static <T> Set<T> Deprecated.static <T> List<T> Deprecated.static <T> TDeprecated.static <T> TDeprecated.static <T> TfindSingle(Iterable<T> source) Deprecated.Returns null if the collection is empty otherwise expects asingle(Iterable)element to be found.static <T> TDeprecated.static <T> List<T> flattenCollections(Class<T> type, Object... things) Deprecated.Recursively unpacks all the given things into a flat list, ensuring they are of a certain type.static List<?> flattenCollections(Object... things) Deprecated.Recursively unpacks all the given things into a flat list.static <K,V> Map <K, Collection<V>> groupBy(Iterable<? extends V> iterable, Transformer<? extends K, V> grouper) Deprecated.static <T,I> T inject(T target, Iterable<? extends I> items, Action<CollectionUtils.InjectionStep<T, I>> action) Deprecated.static <T> List<T> intersection(Collection<? extends Collection<T>> availableValuesByDescriptor) Deprecated.static StringDeprecated.Creates a string withtoString()of each object with the given separator.static StringDeprecated.Creates a string withtoString()of each object with the given separator.static <T> List<T> nonEmptyOrNull(Iterable<T> iterable) Deprecated.static <T> org.gradle.internal.Pair<Collection<T>, Collection<T>> Deprecated.Partition given Collection into a Pair of Collections.static <E> booleanreplace(List<E> list, Spec<? super E> filter, Transformer<? extends E, ? super E> transformer) Deprecated.static <T> TDeprecated.Returns the single element in the collection or throws.static <T> List<T> sort(Iterable<? extends T> things, Comparator<? super T> comparator) Deprecated.Returns a sorted copy of the provided collection of things.static <T extends Comparable<T>>
 List<T> Deprecated.Returns a sorted copy of the provided collection of things.static <C extends Collection<String>>
 CDeprecated.stringize(Collection<?> source) Deprecated.static <T> List<T> Deprecated.static <T> List<T> toList(Enumeration<? extends T> things) Deprecated.static <T> List<T> toList(T[] things) Deprecated.static <T> Set<T> Deprecated.toStringList(Iterable<?> iterable) Deprecated.static <T> Iterable<? extends T> Deprecated.
- 
Constructor Details- 
CollectionUtilspublic CollectionUtils()Deprecated.
 
- 
- 
Method Details- 
findSingleDeprecated.Returns null if the collection is empty otherwise expects asingle(Iterable)element to be found.
- 
singleDeprecated.Returns the single element in the collection or throws.
- 
checkedCastDeprecated.
- 
findFirstDeprecated.
- 
findFirstDeprecated.
- 
firstDeprecated.
- 
anyDeprecated.
- 
anyDeprecated.
- 
filterDeprecated.
- 
filterDeprecated.
- 
filterDeprecated.
- 
sortDeprecated.Returns a sorted copy of the provided collection of things. Uses the provided comparator to sort.
- 
sortDeprecated.Returns a sorted copy of the provided collection of things. Uses the natural ordering of the things.
- 
filterpublic static <T,C extends Collection<T>> C filter(Iterable<? extends T> source, C destination, Spec<? super T> filter) Deprecated.
- 
filterDeprecated.
- 
filterpublic static <K,V> Map<K,V> filter(Map<K, V> map, Map<K, V> destination, Spec<Map.Entry<K, V>> filter) Deprecated.
- 
collectArraypublic static <R,I> R[] collectArray(I[] list, Class<R> newType, Transformer<? extends R, ? super I> transformer) Deprecated.
- 
collectArraypublic static <R,I> R[] collectArray(I[] list, R[] destination, Transformer<? extends R, ? super I> transformer) Deprecated.
- 
collectDeprecated.
- 
collectpublic static <R,I> Set<R> collect(Set<? extends I> set, Transformer<? extends R, ? super I> transformer) Deprecated.
- 
collectpublic static <R,I> List<R> collect(Iterable<? extends I> source, Transformer<? extends R, ? super I> transformer) Deprecated.
- 
collectpublic static <R,I, C collectC extends Collection<R>> (Iterable<? extends I> source, C destination, Transformer<? extends R, ? super I> transformer) Deprecated.
- 
toStringListDeprecated.
- 
flattenCollectionsDeprecated.Recursively unpacks all the given things into a flat list. Nulls are not removed, they are left intact.- Parameters:
- things- The things to flatten
- Returns:
- A flattened list of the given things
 
- 
flattenCollectionsDeprecated.Recursively unpacks all the given things into a flat list, ensuring they are of a certain type. Nulls are not removed, they are left intact. If a non null object cannot be cast to the target type, a ClassCastException will be thrown.- Type Parameters:
- T- The target type in the flattened list
- Parameters:
- things- The things to flatten
- Returns:
- A flattened list of the given things
 
- 
toListDeprecated.
- 
toListDeprecated.
- 
intersectionpublic static <T> List<T> intersection(Collection<? extends Collection<T>> availableValuesByDescriptor) Deprecated.
- 
toListDeprecated.
- 
toSetDeprecated.
- 
compactDeprecated.
- 
stringizeDeprecated.
- 
stringizeDeprecated.
- 
replacepublic static <E> boolean replace(List<E> list, Spec<? super E> filter, Transformer<? extends E, ? super E> transformer) Deprecated.
- 
collectMappublic static <K,V> void collectMap(Map<K, V> destination, Iterable<? extends V> items, Transformer<? extends K, ? super V> keyGenerator) Deprecated.
- 
collectMappublic static <K,V> Map<K,V> collectMap(Iterable<? extends V> items, Transformer<? extends K, ? super V> keyGenerator) Deprecated.Given a set of values, derive a set of keys and return a map
- 
collectMapValuespublic static <K,V> void collectMapValues(Map<K, V> destination, Iterable<? extends K> keys, Transformer<? extends V, ? super K> keyGenerator) Deprecated.
- 
collectMapValuespublic static <K,V> Map<K,V> collectMapValues(Iterable<? extends K> keys, Transformer<? extends V, ? super K> keyGenerator) Deprecated.Given a set of keys, derive a set of values and return a map
- 
everyDeprecated.
- 
addAllDeprecated.Utility for adding an iterable to a collection.- Type Parameters:
- T- The element type of t1
- Parameters:
- t1- The collection to add to
- t2- The iterable to add each item of to the collection
- Returns:
- t1
 
- 
addAllDeprecated.Utility for adding an array to a collection.- Type Parameters:
- T- The element type of t1
- Parameters:
- t1- The collection to add to
- t2- The iterable to add each item of to the collection
- Returns:
- t1
 
- 
diffSetsBypublic static <T> CollectionUtils.SetDiff<T> diffSetsBy(Set<? extends T> left, Set<? extends T> right, Transformer<?, T> compareBy) Deprecated.Provides a "diff report" of how the two sets are similar and how they are different, comparing the entries by some aspect. The transformer is used to generate the value to use to compare the entries by. That is, the entries are not compared by equals by an attribute or characteristic. The transformer is expected to produce a unique value for each entry in a single set. Behaviour is undefined if this condition is not met.- Type Parameters:
- T- The type of the entry objects
- Parameters:
- left- The set on the "left" side of the comparison.
- right- The set on the "right" side of the comparison.
- compareBy- Provides the value to compare entries from either side by
- Returns:
- A representation of the difference
 
- 
joinDeprecated.Creates a string withtoString()of each object with the given separator.expect: join(",", new Object[]{"a"}) == "a" join(",", new Object[]{"a", "b", "c"}) == "a,b,c" join(",", new Object[]{}) == ""Theseparatormust not be null andobjectsmust not be null.- Parameters:
- separator- The string by which to join each string representation
- objects- The objects to join the string representations of
- Returns:
- The joined string
 
- 
joinDeprecated.Creates a string withtoString()of each object with the given separator.expect: join(",", ["a"]) == "a" join(",", ["a", "b", "c"]) == "a,b,c" join(",", []) == ""Theseparatormust not be null andobjectsmust not be null.- Parameters:
- separator- The string by which to join each string representation
- objects- The objects to join the string representations of
- Returns:
- The joined string
 
- 
partitionpublic static <T> org.gradle.internal.Pair<Collection<T>,Collection<T>> partition(Iterable<T> items, Spec<? super T> predicate) Deprecated.Partition given Collection into a Pair of Collections.Left Collection containing entries that satisfy the given predicateRight Collection containing entries that do NOT satisfy the given predicate
- 
injectpublic static <T,I> T inject(T target, Iterable<? extends I> items, Action<CollectionUtils.InjectionStep<T, I>> action) Deprecated.
- 
groupBypublic static <K,V> Map<K,Collection<V>> groupBy(Iterable<? extends V> iterable, Transformer<? extends K, V> grouper) Deprecated.
- 
unpackpublic static <T> Iterable<? extends T> unpack(Iterable<? extends org.gradle.internal.Factory<? extends T>> factories) Deprecated.
- 
nonEmptyOrNullDeprecated.
- 
asCommandLineDeprecated.
 
-