co.unruly.matchers

Class StreamMatchers

java.lang.Object

co.unruly.matchers.StreamMatchers

public class StreamMatchers
extends Object

Constructor Summary

Constructors

Constructor and Description
StreamMatchers()

Method Summary

Modifier and Type	Method and Description
static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>>	allMatch(org.hamcrest.Matcher<T> matcher) A matcher for a finite Stream of objects, all of which must match the given Matcher.
static org.hamcrest.Matcher<java.util.stream.DoubleStream>	allMatchDouble(org.hamcrest.Matcher<Double> matcher) A matcher for a finite Stream of primitive doubles, all of which must match the given Matcher.
static org.hamcrest.Matcher<java.util.stream.IntStream>	allMatchInt(org.hamcrest.Matcher<Integer> matcher) A matcher for a finite Stream of primitive ints, all of which must match the given Matcher.
static org.hamcrest.Matcher<java.util.stream.LongStream>	allMatchLong(org.hamcrest.Matcher<Long> matcher) A matcher for a finite Stream of primitive longs, all of which must match the given Matcher.
static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>>	anyMatch(org.hamcrest.Matcher<T> matcher) A matcher for a finite Stream of objects, at least one of which must match the given Matcher.
static org.hamcrest.Matcher<java.util.stream.DoubleStream>	anyMatchDouble(org.hamcrest.Matcher<Double> matcher) A matcher for a finite Stream of primitive doubles, at least one of which must match the given Matcher.
static org.hamcrest.Matcher<java.util.stream.IntStream>	anyMatchInt(org.hamcrest.Matcher<Integer> matcher) A matcher for a finite Stream of primitive ints, at least one of which must match the given Matcher.
static org.hamcrest.Matcher<java.util.stream.LongStream>	anyMatchLong(org.hamcrest.Matcher<Long> matcher) A matcher for a finite Stream of primitive longs, at least one of which must match the given Matcher.
static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<S>	contains(org.hamcrest.Matcher<T>... expectedMatchers) The BaseStream must produce exactly the given expected items in order, and no more.
static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<S>	contains(T... expected) The BaseStream must produce exactly the given expected items in order, and no more.
static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<java.util.stream.BaseStream<T,S>>	empty()
static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<java.util.stream.BaseStream<T,S>>	equalTo(java.util.stream.BaseStream<T,S> expected) A matcher for a finite Stream producing the same number of items as the expected Stream, and producing equal items as expected in the same order.
static org.hamcrest.Matcher<java.util.stream.DoubleStream>	startsWith(java.util.stream.DoubleStream expected, long limit) A matcher for potentially infinite Streams of primitive doubles where the first limit items from each must be equal
static org.hamcrest.Matcher<java.util.stream.IntStream>	startsWith(java.util.stream.IntStream expected, long limit) A matcher for potentially infinite Streams of primitive ints where the first limit items from each must be equal
static org.hamcrest.Matcher<java.util.stream.LongStream>	startsWith(java.util.stream.LongStream expected, long limit) A matcher for potentially infinite Streams of primitive ints where the first limit items from each must be equal
static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>>	startsWith(java.util.stream.Stream<T> expected, long limit) A matcher for potentially infinite Streams of objects where the first limit items from each must be equal
static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>>	startsWith(T... expected) A matcher for a potentially infinite Stream of objects against n expected items, matching if the first n items produced by the Stream equal the expected items in order.
static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>>	startsWithAll(org.hamcrest.Matcher<T> matcher, long limit) A matcher for potentially infinite Streams of objects, the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.DoubleStream>	startsWithAllDouble(org.hamcrest.Matcher<Double> matcher, long limit) A matcher for potentially infinite Streams of primitive doubles, the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.IntStream>	startsWithAllInt(org.hamcrest.Matcher<Integer> matcher, long limit) A matcher for potentially infinite Streams of primitive ints, the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.LongStream>	startsWithAllLong(org.hamcrest.Matcher<Long> matcher, long limit) A matcher for potentially infinite Streams of primitive longs, the first limit of which must match the given Matcher
static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>>	startsWithAny(org.hamcrest.Matcher<T> matcher, long limit) A matcher for potentially infinite Streams of objects, at least one of the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.DoubleStream>	startsWithAnyDouble(org.hamcrest.Matcher<Double> matcher, long limit) A matcher for potentially infinite Streams of primitive doubles, at least one of the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.IntStream>	startsWithAnyInt(org.hamcrest.Matcher<Integer> matcher, long limit) A matcher for potentially infinite Streams of primitive ints, at least one of the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.LongStream>	startsWithAnyLong(org.hamcrest.Matcher<Long> matcher, long limit) A matcher for potentially infinite Streams of primitive longs, at least one of the first limit of which must match the given Matcher
static org.hamcrest.Matcher<java.util.stream.DoubleStream>	startsWithDouble(double... expected) A matcher for a potentially infinite Stream of primitive doubles against n expected items, matching if the first n items produced by the Stream equal the expected items in order.
static org.hamcrest.Matcher<java.util.stream.IntStream>	startsWithInt(int... expected) A matcher for a potentially infinite Stream of primitive ints against n expected items, matching if the first n items produced by the Stream equal the expected items in order.
static org.hamcrest.Matcher<java.util.stream.LongStream>	startsWithLong(long... expected) A matcher for a potentially infinite Stream of primitive longs against n expected items, matching if the first n items produced by the Stream equal the expected items in order.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamMatchers

public StreamMatchers()

Method Detail

empty

public static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<java.util.stream.BaseStream<T,S>> empty()

equalTo

public static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<java.util.stream.BaseStream<T,S>> equalTo(java.util.stream.BaseStream<T,S> expected)

A matcher for a finite Stream producing the same number of items as the expected Stream, and producing equal items as expected in the same order. For infinite Streams use startsWith(java.util.stream.Stream<T>, long)

Type Parameters:

T - The type of items produced by each BaseStream

S - The type of BaseStream

Parameters:

expected - A BaseStream against which to compare

See Also:

startsWith(java.util.stream.Stream<T>, long), startsWithInt(int...), startsWithLong(long...), startsWithDouble(double...)

startsWith

public static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>> startsWith(java.util.stream.Stream<T> expected,
                                                                              long limit)

A matcher for potentially infinite Streams of objects where the first limit items from each must be equal

Type Parameters:

T - The type of items produced by each Stream

Parameters:

expected - A Stream to check against

limit - Only check this number of items from actual Stream

See Also:

equalTo(java.util.stream.BaseStream<T, S>), startsWithInt(int...), startsWithLong(long...), startsWithDouble(double...)

startsWith

public static org.hamcrest.Matcher<java.util.stream.DoubleStream> startsWith(java.util.stream.DoubleStream expected,
                                                                             long limit)

A matcher for potentially infinite Streams of primitive doubles where the first limit items from each must be equal

Parameters:

expected - A Stream to check against

limit - Only check this number of items from actual Stream

See Also:

equalTo(java.util.stream.BaseStream<T, S>), startsWith(java.util.stream.Stream<T>, long), startsWithInt(int...), startsWithLong(long...)

startsWith

public static org.hamcrest.Matcher<java.util.stream.IntStream> startsWith(java.util.stream.IntStream expected,
                                                                          long limit)

A matcher for potentially infinite Streams of primitive ints where the first limit items from each must be equal

Parameters:

expected - A Stream to check against

limit - Only check this number of items from actual Stream

See Also:

equalTo(java.util.stream.BaseStream<T, S>), startsWith(java.util.stream.Stream<T>, long), startsWithLong(long...), startsWithDouble(double...)

startsWith

public static org.hamcrest.Matcher<java.util.stream.LongStream> startsWith(java.util.stream.LongStream expected,
                                                                           long limit)

A matcher for potentially infinite Streams of primitive ints where the first limit items from each must be equal

Parameters:

expected - A Stream to check against

limit - Only check this number of items from actual Stream

See Also:

equalTo(java.util.stream.BaseStream<T, S>), startsWith(java.util.stream.Stream<T>, long), startsWithInt(int...), startsWithDouble(double...)

startsWithAll

public static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>> startsWithAll(org.hamcrest.Matcher<T> matcher,
                                                                                 long limit)

A matcher for potentially infinite Streams of objects, the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

allMatch(org.hamcrest.Matcher<T>), startsWithAllLong(org.hamcrest.Matcher<java.lang.Long>, long), startsWithAllInt(org.hamcrest.Matcher<java.lang.Integer>, long), startsWithAllDouble(org.hamcrest.Matcher<java.lang.Double>, long)

startsWithAllLong

public static org.hamcrest.Matcher<java.util.stream.LongStream> startsWithAllLong(org.hamcrest.Matcher<Long> matcher,
                                                                                  long limit)

A matcher for potentially infinite Streams of primitive longs, the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

allMatchLong(org.hamcrest.Matcher<java.lang.Long>), startsWithAll(org.hamcrest.Matcher<T>, long), startsWithAllInt(org.hamcrest.Matcher<java.lang.Integer>, long), startsWithAllDouble(org.hamcrest.Matcher<java.lang.Double>, long)

startsWithAllInt

public static org.hamcrest.Matcher<java.util.stream.IntStream> startsWithAllInt(org.hamcrest.Matcher<Integer> matcher,
                                                                                long limit)

A matcher for potentially infinite Streams of primitive ints, the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

allMatchInt(org.hamcrest.Matcher<java.lang.Integer>), startsWithAll(org.hamcrest.Matcher<T>, long), startsWithAllLong(org.hamcrest.Matcher<java.lang.Long>, long), startsWithAllDouble(org.hamcrest.Matcher<java.lang.Double>, long)

startsWithAllDouble

public static org.hamcrest.Matcher<java.util.stream.DoubleStream> startsWithAllDouble(org.hamcrest.Matcher<Double> matcher,
                                                                                      long limit)

A matcher for potentially infinite Streams of primitive doubles, the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

allMatchDouble(org.hamcrest.Matcher<java.lang.Double>), startsWithAll(org.hamcrest.Matcher<T>, long), startsWithAllInt(org.hamcrest.Matcher<java.lang.Integer>, long), startsWithAllLong(org.hamcrest.Matcher<java.lang.Long>, long)

startsWithAny

public static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>> startsWithAny(org.hamcrest.Matcher<T> matcher,
                                                                                 long limit)

A matcher for potentially infinite Streams of objects, at least one of the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

anyMatch(org.hamcrest.Matcher<T>), startsWithAnyInt(org.hamcrest.Matcher<java.lang.Integer>, long), startsWithAnyLong(org.hamcrest.Matcher<java.lang.Long>, long), startsWithAnyDouble(org.hamcrest.Matcher<java.lang.Double>, long)

startsWithAnyLong

public static org.hamcrest.Matcher<java.util.stream.LongStream> startsWithAnyLong(org.hamcrest.Matcher<Long> matcher,
                                                                                  long limit)

A matcher for potentially infinite Streams of primitive longs, at least one of the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

anyMatchLong(org.hamcrest.Matcher<java.lang.Long>), startsWithAny(org.hamcrest.Matcher<T>, long), startsWithAnyInt(org.hamcrest.Matcher<java.lang.Integer>, long), startsWithAnyDouble(org.hamcrest.Matcher<java.lang.Double>, long)

startsWithAnyDouble

public static org.hamcrest.Matcher<java.util.stream.DoubleStream> startsWithAnyDouble(org.hamcrest.Matcher<Double> matcher,
                                                                                      long limit)

A matcher for potentially infinite Streams of primitive doubles, at least one of the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

anyMatchDouble(org.hamcrest.Matcher<java.lang.Double>), startsWithAny(org.hamcrest.Matcher<T>, long), startsWithAnyInt(org.hamcrest.Matcher<java.lang.Integer>, long), startsWithAnyLong(org.hamcrest.Matcher<java.lang.Long>, long)

startsWithAnyInt

public static org.hamcrest.Matcher<java.util.stream.IntStream> startsWithAnyInt(org.hamcrest.Matcher<Integer> matcher,
                                                                                long limit)

A matcher for potentially infinite Streams of primitive ints, at least one of the first limit of which must match the given Matcher

Parameters:

matcher - A matcher to apply to items produced from the Stream

limit - Only check this number of items from the Stream

See Also:

anyMatchInt(org.hamcrest.Matcher<java.lang.Integer>), startsWithAny(org.hamcrest.Matcher<T>, long), startsWithAnyLong(org.hamcrest.Matcher<java.lang.Long>, long), startsWithAnyDouble(org.hamcrest.Matcher<java.lang.Double>, long)

contains

@SafeVarargs
public static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<S> contains(org.hamcrest.Matcher<T>... expectedMatchers)

The BaseStream must produce exactly the given expected items in order, and no more. For infinite BaseStreams see #startsWith(T...) or a primitive stream variant

Type Parameters:

T - The type of items

S - The type of the BaseStream

Parameters:

expectedMatchers - Matchers for the items that should be produced by the BaseStream

See Also:

#startsWith(T...), startsWithInt(int...), startsWithLong(long...), startsWithDouble(double...)

contains

@SafeVarargs
public static <T,S extends java.util.stream.BaseStream<T,S>> org.hamcrest.Matcher<S> contains(T... expected)

The BaseStream must produce exactly the given expected items in order, and no more. For infinite BaseStreams see #startsWith(T...) or a primitive stream variant

Type Parameters:

T - The type of items

S - The type of the BaseStream

Parameters:

expected - The items that should be produced by the BaseStream

See Also:

#startsWith(T...), startsWithInt(int...), startsWithLong(long...), startsWithDouble(double...)

allMatch

public static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>> allMatch(org.hamcrest.Matcher<T> matcher)

A matcher for a finite Stream of objects, all of which must match the given Matcher. For infinite Streams see startsWithAll(org.hamcrest.Matcher<T>, long)

Type Parameters:

T - The type of items produced by the Stream

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAll(org.hamcrest.Matcher<T>, long), allMatchInt(org.hamcrest.Matcher<java.lang.Integer>), allMatchLong(org.hamcrest.Matcher<java.lang.Long>), allMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

allMatchInt

public static org.hamcrest.Matcher<java.util.stream.IntStream> allMatchInt(org.hamcrest.Matcher<Integer> matcher)

A matcher for a finite Stream of primitive ints, all of which must match the given Matcher. For infinite Streams see startsWithAllInt(org.hamcrest.Matcher<java.lang.Integer>, long)

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAllInt(org.hamcrest.Matcher<java.lang.Integer>, long), allMatch(org.hamcrest.Matcher<T>), allMatchLong(org.hamcrest.Matcher<java.lang.Long>), allMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

allMatchLong

public static org.hamcrest.Matcher<java.util.stream.LongStream> allMatchLong(org.hamcrest.Matcher<Long> matcher)

A matcher for a finite Stream of primitive longs, all of which must match the given Matcher. For infinite Streams see startsWithAllLong(org.hamcrest.Matcher<java.lang.Long>, long)

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAllLong(org.hamcrest.Matcher<java.lang.Long>, long), allMatch(org.hamcrest.Matcher<T>), allMatchInt(org.hamcrest.Matcher<java.lang.Integer>), allMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

allMatchDouble

public static org.hamcrest.Matcher<java.util.stream.DoubleStream> allMatchDouble(org.hamcrest.Matcher<Double> matcher)

A matcher for a finite Stream of primitive doubles, all of which must match the given Matcher. For infinite Streams see startsWithAllDouble(org.hamcrest.Matcher<java.lang.Double>, long)

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAllDouble(org.hamcrest.Matcher<java.lang.Double>, long), allMatch(org.hamcrest.Matcher<T>), allMatchInt(org.hamcrest.Matcher<java.lang.Integer>), allMatchLong(org.hamcrest.Matcher<java.lang.Long>)

anyMatch

public static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>> anyMatch(org.hamcrest.Matcher<T> matcher)

A matcher for a finite Stream of objects, at least one of which must match the given Matcher. For infinite Streams see startsWithAny(org.hamcrest.Matcher<T>, long)

Type Parameters:

T - The type of items produced by the Stream

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAny(org.hamcrest.Matcher<T>, long), anyMatchInt(org.hamcrest.Matcher<java.lang.Integer>), anyMatchLong(org.hamcrest.Matcher<java.lang.Long>), anyMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

anyMatchLong

public static org.hamcrest.Matcher<java.util.stream.LongStream> anyMatchLong(org.hamcrest.Matcher<Long> matcher)

A matcher for a finite Stream of primitive longs, at least one of which must match the given Matcher. For infinite Streams see startsWithAnyLong(org.hamcrest.Matcher<java.lang.Long>, long)

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAnyLong(org.hamcrest.Matcher<java.lang.Long>, long), anyMatch(org.hamcrest.Matcher<T>), anyMatchInt(org.hamcrest.Matcher<java.lang.Integer>), anyMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

anyMatchDouble

public static org.hamcrest.Matcher<java.util.stream.DoubleStream> anyMatchDouble(org.hamcrest.Matcher<Double> matcher)

A matcher for a finite Stream of primitive doubles, at least one of which must match the given Matcher. For infinite Streams see startsWithAnyDouble(org.hamcrest.Matcher<java.lang.Double>, long)

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAnyDouble(org.hamcrest.Matcher<java.lang.Double>, long), anyMatch(org.hamcrest.Matcher<T>), anyMatchInt(org.hamcrest.Matcher<java.lang.Integer>), anyMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

anyMatchInt

public static org.hamcrest.Matcher<java.util.stream.IntStream> anyMatchInt(org.hamcrest.Matcher<Integer> matcher)

A matcher for a finite Stream of primitive ints, at least one of which must match the given Matcher. For infinite Streams see startsWithAnyInt(org.hamcrest.Matcher<java.lang.Integer>, long)

Parameters:

matcher - A Matcher against which to compare items from the Stream

See Also:

startsWithAnyInt(org.hamcrest.Matcher<java.lang.Integer>, long), anyMatch(org.hamcrest.Matcher<T>), anyMatchLong(org.hamcrest.Matcher<java.lang.Long>), anyMatchDouble(org.hamcrest.Matcher<java.lang.Double>)

startsWith

@SafeVarargs
public static <T> org.hamcrest.Matcher<java.util.stream.Stream<T>> startsWith(T... expected)

A matcher for a potentially infinite Stream of objects against n expected items, matching if the first n items produced by the Stream equal the expected items in order. Whether the Stream would subsequently produce additional items is irrelevant.

Type Parameters:

T - The type of items

Parameters:

expected - The expected items produced first by the Stream

See Also:

contains(org.hamcrest.Matcher<T>...), startsWithInt(int...), startsWithDouble(double...), startsWithLong(long...)

startsWithDouble

public static org.hamcrest.Matcher<java.util.stream.DoubleStream> startsWithDouble(double... expected)

A matcher for a potentially infinite Stream of primitive doubles against n expected items, matching if the first n items produced by the Stream equal the expected items in order. Whether the Stream would subsequently produce additional items is irrelevant.

Parameters:

expected - The expected items produced first by the Stream

See Also:

contains(org.hamcrest.Matcher<T>...), startsWith(java.util.stream.Stream<T>, long), startsWithInt(int...), startsWithLong(long...)

startsWithLong

public static org.hamcrest.Matcher<java.util.stream.LongStream> startsWithLong(long... expected)

A matcher for a potentially infinite Stream of primitive longs against n expected items, matching if the first n items produced by the Stream equal the expected items in order. Whether the Stream would subsequently produce additional items is irrelevant.

Parameters:

expected - The expected items produced first by the Stream

See Also:

contains(org.hamcrest.Matcher<T>...), startsWith(java.util.stream.Stream<T>, long), startsWithInt(int...), startsWithDouble(double...)

startsWithInt

public static org.hamcrest.Matcher<java.util.stream.IntStream> startsWithInt(int... expected)

A matcher for a potentially infinite Stream of primitive ints against n expected items, matching if the first n items produced by the Stream equal the expected items in order. Whether the Stream would subsequently produce additional items is irrelevant.

Parameters:

expected - The expected items produced first by the Stream

See Also:

contains(org.hamcrest.Matcher<T>...), startsWith(java.util.stream.Stream<T>, long), startsWithLong(long...), startsWithDouble(double...)