net.openhft.chronicle.testframework

Class Combination

java.lang.Object

net.openhft.chronicle.testframework.Combination

public final class Combination
extends Object

Utility class that provides functionality to generate all possible combinations of a given set of elements. The class eagerly calculates the combinations.

This class cannot be instantiated.

Author:

Per Minborg

Method Summary

Modifier and Type	Method and Description
static <T> Stream<Set<T>>	of(@NotNull Collection<T> items) Creates and returns a stream of all possible combinations of the given elements.
static <T> Stream<Set<T>>	of(@NotNull Stream<T> items) Creates and returns a stream of all possible combinations of the given elements.
static <T> Stream<Set<T>>	of(T... items) Creates and returns a stream of all possible combinations of the given elements.

Methods inherited from class java.lang.Object

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

Method Detail

of

@SafeVarargs
public static <T> Stream<Set<T>> of(@NotNull
                                                 T... items)

Creates and returns a stream of all possible combinations of the given elements.

The order of the combinations in the stream is unspecified.

Type Parameters:

T - element type

Parameters:

items - the array of items to combine

Returns:

a stream of sets containing all possible combinations of the given elements

Throws:

NullPointerException - if the provided items array is null.

of

public static <T> Stream<Set<T>> of(@NotNull
                                    @NotNull Collection<T> items)

Creates and returns a stream of all possible combinations of the given elements.

The order of the combinations in the stream is unspecified.

Type Parameters:

T - element type

Parameters:

items - a collection of items to combine

Returns:

a stream of sets containing all possible combinations of the given elements

Throws:

NullPointerException - if the provided items collection is null.

of

public static <T> Stream<Set<T>> of(@NotNull
                                    @NotNull Stream<T> items)

Creates and returns a stream of all possible combinations of the given elements.

The order of the combinations in the stream is unspecified.

It is unspecified if the method lazily consumes the provided stream before providing the result or not.

Type Parameters:

T - element type

Parameters:

items - a stream of items to combine

Returns:

a stream of sets containing all possible combinations of the given elements

Throws:

NullPointerException - if the provided items stream is null.