net.emaze.dysfunctional

Class Groups

java.lang.Object

net.emaze.dysfunctional.Groups

public abstract class Groups
extends Object

groupBy, partition, indexBy.

Author:

rferranti

Constructor Summary

Constructors

Constructor and Description
Groups()

Method Summary

Modifier and Type	Method and Description
static <K,V> Map<K,List<V>>	groupBy(Iterable<V> groupies, Function<V,K> grouper) Groups elements from an iterable in the key evaluated from the passed function.
static <K,V,C extends Collection<V>> Map<K,C>	groupBy(Iterable<V> groupies, Function<V,K> grouper, Supplier<C> collectionProvider) Groups elements from an iterable in the key evaluated from the passed function.
static <K,V,C extends Collection<V>,M extends Map<K,C>> Map<K,C>	groupBy(Iterable<V> groupies, Function<V,K> grouper, Supplier<C> collectionProvider, Supplier<M> mapProvider) Groups elements from an iterable in the key evaluated from the passed function.
static <K,V> Map<K,List<V>>	groupBy(Iterator<V> groupies, Function<V,K> grouper) Groups elements from an iterator in the key evaluated from the passed function.
static <K,V,C extends Collection<V>> Map<K,C>	groupBy(Iterator<V> groupies, Function<V,K> grouper, Supplier<C> collectionProvider) Groups elements from an iterator in the key evaluated from the passed function.
static <K,V,C extends Collection<V>,M extends Map<K,C>> Map<K,C>	groupBy(Iterator<V> groupies, Function<V,K> grouper, Supplier<C> collectionProvider, Supplier<M> mapProvider) Groups elements from an iterator in the key evaluated from the passed function.
static <K,V> Map<K,List<V>>	groupBy(V[] groupies, Function<V,K> grouper) Groups elements from an array in the key evaluated from the passed function.
static <K,V,C extends Collection<V>> Map<K,C>	groupBy(V[] groupies, Function<V,K> grouper, Supplier<C> collectionProvider) Groups elements from an array in the key evaluated from the passed function.
static <K,V,C extends Collection<V>,M extends Map<K,C>> Map<K,C>	groupBy(V[] groupies, Function<V,K> grouper, Supplier<C> collectionProvider, Supplier<M> mapProvider) Groups elements from an array in the key evaluated from the passed function.
static <K,V> Map<K,V>	indexBy(Iterable<V> groupies, Function<V,K> indexer) Indexes elements from the iterable using passed function.
static <K,V,M extends Map<K,V>> Map<K,V>	indexBy(Iterable<V> groupies, Function<V,K> indexer, Supplier<M> mapProvider) Indexes elements from the iterable using passed function.
static <K,V> Map<K,V>	indexBy(Iterator<V> groupies, Function<V,K> indexer) Indexes elements from the iterator using passed function.
static <K,V,M extends Map<K,V>> Map<K,V>	indexBy(Iterator<V> groupies, Function<V,K> indexer, Supplier<M> mapProvider) Indexes elements from the iterator using passed function.
static <K,V> Map<K,V>	indexBy(V[] groupies, Function<V,K> indexer) Indexes elements from the array using passed function.
static <K,V,M extends Map<K,V>> Map<K,V>	indexBy(V[] groupies, Function<V,K> indexer, Supplier<M> mapProvider) Indexes elements from the array using passed function.
static <T> Pair<List<T>,List<T>>	partition(Iterable<T> values, Predicate<T> partitioner) Partitions elements from the iterable into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T,C extends Collection<T>> Pair<C,C>	partition(Iterable<T> values, Predicate<T> partitioner, Supplier<C> collectionsProvider) Partitions elements from the iterable into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T,CA extends Collection<T>,CR extends Collection<T>> Pair<CA,CR>	partition(Iterable<T> values, Predicate<T> partitioner, Supplier<CA> acceptedCollectionProvider, Supplier<CR> refusedCollectionProvider) Partitions elements from the iterable into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T> Pair<List<T>,List<T>>	partition(Iterator<T> values, Predicate<T> partitioner) Partitions elements from the iterator into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T,C extends Collection<T>> Pair<C,C>	partition(Iterator<T> values, Predicate<T> partitioner, Supplier<C> collectionsProvider) Partitions elements from the iterator into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T,CA extends Collection<T>,CR extends Collection<T>> Pair<CA,CR>	partition(Iterator<T> values, Predicate<T> partitioner, Supplier<CA> acceptedCollectionProvider, Supplier<CR> refusedCollectionProvider) Partitions elements from the iterator into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T> Pair<List<T>,List<T>>	partition(T[] values, Predicate<T> partitioner) Partitions elements from the array into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T,C extends Collection<T>> Pair<C,C>	partition(T[] values, Predicate<T> partitioner, Supplier<C> collectionsProvider) Partitions elements from the array into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).
static <T,CA extends Collection<T>,CR extends Collection<T>> Pair<CA,CR>	partition(T[] values, Predicate<T> partitioner, Supplier<CA> acceptedCollectionProvider, Supplier<CR> refusedCollectionProvider) Partitions elements from the array into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Groups

public Groups()

Method Detail

groupBy

public static <K,V> Map<K,List<V>> groupBy(Iterator<V> groupies,
                                           Function<V,K> grouper)

Groups elements from an iterator in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

Returns:

a map containing grouped values

groupBy

public static <K,V,C extends Collection<V>> Map<K,C> groupBy(Iterator<V> groupies,
                                                             Function<V,K> grouper,
                                                             Supplier<C> collectionProvider)

Groups elements from an iterator in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

C - the collection type used as value of the map

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

collectionProvider - the values collection supplier

Returns:

a map containing grouped values

groupBy

public static <K,V,C extends Collection<V>,M extends Map<K,C>> Map<K,C> groupBy(Iterator<V> groupies,
                                                                                Function<V,K> grouper,
                                                                                Supplier<C> collectionProvider,
                                                                                Supplier<M> mapProvider)

Groups elements from an iterator in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

C - the collection type used as value of the map

M - the result map type

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

collectionProvider - the values collection supplier

mapProvider - the map collection supplier

Returns:

a map containing grouped values

groupBy

public static <K,V> Map<K,List<V>> groupBy(Iterable<V> groupies,
                                           Function<V,K> grouper)

Groups elements from an iterable in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

Returns:

a map containing grouped values

groupBy

public static <K,V,C extends Collection<V>> Map<K,C> groupBy(Iterable<V> groupies,
                                                             Function<V,K> grouper,
                                                             Supplier<C> collectionProvider)

Groups elements from an iterable in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

C - the collection type used as value of the map

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

collectionProvider - the values collection supplier

Returns:

a map containing grouped values

groupBy

public static <K,V,C extends Collection<V>,M extends Map<K,C>> Map<K,C> groupBy(Iterable<V> groupies,
                                                                                Function<V,K> grouper,
                                                                                Supplier<C> collectionProvider,
                                                                                Supplier<M> mapProvider)

Groups elements from an iterable in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

C - the collection type used as value of the map

M - the result map type

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

collectionProvider - the values collection supplier

mapProvider - the map collection supplier

Returns:

a map containing grouped values

groupBy

public static <K,V> Map<K,List<V>> groupBy(V[] groupies,
                                           Function<V,K> grouper)

Groups elements from an array in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

Returns:

a map containing grouped values

groupBy

public static <K,V,C extends Collection<V>> Map<K,C> groupBy(V[] groupies,
                                                             Function<V,K> grouper,
                                                             Supplier<C> collectionProvider)

Groups elements from an array in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

C - the collection type used as value of the map

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

collectionProvider - the values collection supplier

Returns:

a map containing grouped values

groupBy

public static <K,V,C extends Collection<V>,M extends Map<K,C>> Map<K,C> groupBy(V[] groupies,
                                                                                Function<V,K> grouper,
                                                                                Supplier<C> collectionProvider,
                                                                                Supplier<M> mapProvider)

Groups elements from an array in the key evaluated from the passed function. E.g: groupBy([1, 2, 3, 1], id) -> { 1: [1,1], 2: [2], 3: [3]}

Type Parameters:

K - the grouped key type

V - the grouped value type

C - the collection type used as value of the map

M - the result map type

Parameters:

groupies - the elements to be grouped

grouper - the function used to group elements

collectionProvider - the values collection supplier

mapProvider - the map collection supplier

Returns:

a map containing grouped values

partition

public static <T> Pair<List<T>,List<T>> partition(Iterator<T> values,
                                                  Predicate<T> partitioner)

Partitions elements from the iterator into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

Returns:

the two partitioned collections in a pair.

partition

public static <T,C extends Collection<T>> Pair<C,C> partition(Iterator<T> values,
                                                              Predicate<T> partitioner,
                                                              Supplier<C> collectionsProvider)

Partitions elements from the iterator into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

C - the partitioned elements collection type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

collectionsProvider - a collection supplier used to create both elements collection

Returns:

the two partitioned collections in a pair.

partition

public static <T,CA extends Collection<T>,CR extends Collection<T>> Pair<CA,CR> partition(Iterator<T> values,
                                                                                          Predicate<T> partitioner,
                                                                                          Supplier<CA> acceptedCollectionProvider,
                                                                                          Supplier<CR> refusedCollectionProvider)

Partitions elements from the iterator into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

CA - the accepted elements collection type

CR - the refused elements collection type

T - the element type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

acceptedCollectionProvider - a collection supplier used to create accepted elements collection

refusedCollectionProvider - a collection supplier used to create refused elements collection

Returns:

the two partitioned collections in a pair.

partition

public static <T> Pair<List<T>,List<T>> partition(Iterable<T> values,
                                                  Predicate<T> partitioner)

Partitions elements from the iterable into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

Returns:

the two partitioned collections in a pair.

partition

public static <T,C extends Collection<T>> Pair<C,C> partition(Iterable<T> values,
                                                              Predicate<T> partitioner,
                                                              Supplier<C> collectionsProvider)

Partitions elements from the iterable into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

C - the partitioned elements collection type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

collectionsProvider - a collection supplier used to create both elements collection

Returns:

the two partitioned collections in a pair.

partition

public static <T,CA extends Collection<T>,CR extends Collection<T>> Pair<CA,CR> partition(Iterable<T> values,
                                                                                          Predicate<T> partitioner,
                                                                                          Supplier<CA> acceptedCollectionProvider,
                                                                                          Supplier<CR> refusedCollectionProvider)

Partitions elements from the iterable into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

CA - the accepted elements collection type

CR - the refused elements collection type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

acceptedCollectionProvider - a collection supplier used to create accepted elements collection

refusedCollectionProvider - a collection supplier used to create refused elements collection

Returns:

the two partitioned collections in a pair.

partition

public static <T> Pair<List<T>,List<T>> partition(T[] values,
                                                  Predicate<T> partitioner)

Partitions elements from the array into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

Returns:

the two partitioned collections in a pair.

partition

public static <T,C extends Collection<T>> Pair<C,C> partition(T[] values,
                                                              Predicate<T> partitioner,
                                                              Supplier<C> collectionsProvider)

Partitions elements from the array into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

T - the element type

C - the partitioned elements collection type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

collectionsProvider - a collection supplier used to create both elements collection

Returns:

the two partitioned collections in a pair.

partition

public static <T,CA extends Collection<T>,CR extends Collection<T>> Pair<CA,CR> partition(T[] values,
                                                                                          Predicate<T> partitioner,
                                                                                          Supplier<CA> acceptedCollectionProvider,
                                                                                          Supplier<CR> refusedCollectionProvider)

Partitions elements from the array into two collections containing elements that match the predicate (left side collection) and elements that don't (right side collection). E.g: partition([1,2,3,4], isOdd) -> ([1,3],[2,4])

Type Parameters:

CA - the accepted elements collection type

CR - the refused elements collection type

T - the element type

Parameters:

values - the values to be partitioned

partitioner - the predicate used to partition values

acceptedCollectionProvider - a collection supplier used to create accepted elements collection

refusedCollectionProvider - a collection supplier used to create refused elements collection

Returns:

the two partitioned collections in a pair.

indexBy

public static <K,V,M extends Map<K,V>> Map<K,V> indexBy(Iterable<V> groupies,
                                                        Function<V,K> indexer,
                                                        Supplier<M> mapProvider)

Indexes elements from the iterable using passed function. E.g: indexBy([1,2,3,4], id) -> {1:1, 2:2, 3:3, 4:4}

Type Parameters:

K - the key type

V - the value type

M - the map type

Parameters:

groupies - elements to be indexed

indexer - the function used to index elements

mapProvider - a supplier used to create the resulting map

Returns:

indexed elements in a map

indexBy

public static <K,V> Map<K,V> indexBy(Iterable<V> groupies,
                                     Function<V,K> indexer)

Indexes elements from the iterable using passed function. E.g: indexBy([1,2,3,4], id) -> {1:1, 2:2, 3:3, 4:4}

Type Parameters:

K - the key type

V - the value type

Parameters:

groupies - elements to be indexed

indexer - the function used to index elements

Returns:

indexed elements in a map

indexBy

public static <K,V,M extends Map<K,V>> Map<K,V> indexBy(Iterator<V> groupies,
                                                        Function<V,K> indexer,
                                                        Supplier<M> mapProvider)

Indexes elements from the iterator using passed function. E.g: indexBy([1,2,3,4], id) -> {1:1, 2:2, 3:3, 4:4}

Type Parameters:

K - the key type

V - the value type

M - the map type

Parameters:

groupies - elements to be indexed

indexer - the function used to index elements

mapProvider - a supplier used to create the resulting map

Returns:

indexed elements in a map

indexBy

public static <K,V> Map<K,V> indexBy(Iterator<V> groupies,
                                     Function<V,K> indexer)

Indexes elements from the iterator using passed function. E.g: indexBy([1,2,3,4], id) -> {1:1, 2:2, 3:3, 4:4}

Type Parameters:

K - the key type

V - the value type

Parameters:

groupies - elements to be indexed

indexer - the function used to index elements

Returns:

indexed elements in a map

indexBy

public static <K,V,M extends Map<K,V>> Map<K,V> indexBy(V[] groupies,
                                                        Function<V,K> indexer,
                                                        Supplier<M> mapProvider)

Indexes elements from the array using passed function. E.g: indexBy([1,2,3,4], id) -> {1:1, 2:2, 3:3, 4:4}

Type Parameters:

K - the key type

V - the value type

M - the map type

Parameters:

groupies - elements to be indexed

indexer - the function used to index elements

mapProvider - a supplier used to create the resulting map

Returns:

indexed elements in a map

indexBy

public static <K,V> Map<K,V> indexBy(V[] groupies,
                                     Function<V,K> indexer)

Indexes elements from the array using passed function. E.g: indexBy([1,2,3,4], id) -> {1:1, 2:2, 3:3, 4:4}

Type Parameters:

K - the key type

V - the value type

Parameters:

groupies - elements to be indexed

indexer - the function used to index elements

Returns:

indexed elements in a map