org.whaka.asserts

Class UberMatchers

java.lang.Object

org.whaka.asserts.UberMatchers

public final class UberMatchers
extends java.lang.Object

Class provides static factory methods for custom Hamcrest matchers provided by the library.

See Also:

NumberMatchers

Method Summary

Modifier and Type	Method and Description
static <T> org.hamcrest.Matcher<T>	consistentWith(T value, org.hamcrest.Matcher<? super T> matcher) Create a matcher that will check that tested item and specified value are either both consistently matched, or both consistently not matched by the specified matcher.
static <T,V> org.hamcrest.Matcher<V>	convert(org.hamcrest.Matcher<T> m, java.util.function.Function<V,T> f) Create a matcher that will apply specified function to the received value and then delegate result to the specified matcher delegate.
static <T> org.hamcrest.Matcher<T>	deeplyEqualTo(T item) Create a matcher that will check that tested item and specified value are equal according to the ComparisonPerformers.DEEP_EQUALS performer.
static <T> org.hamcrest.Matcher<T>	equalTo(T item, ComparisonPerformer<? super T> performer) Create a matcher that will check that tested item and specified value are equal according to the specified ComparisonPerformer.
static <T> org.hamcrest.Matcher<java.util.Collection<? extends T>>	hasAnyItem(java.util.Collection<T> items) Equal to hasAnyItem(Collection, BiPredicate) with Objects.deepEquals(Object, Object) used as a predicate.
static <T> org.hamcrest.Matcher<java.util.Collection<? extends T>>	hasAnyItem(java.util.Collection<T> items, java.util.function.BiPredicate<T,T> matcher) Create a matcher that will check that a collection contains any one of the specified item.
static <T> org.hamcrest.Matcher<java.util.Collection<? extends T>>	hasItem(T item, java.util.function.BiPredicate<T,T> matcher) Create a matcher that will check that a collection contains the specified item.
static <T> org.hamcrest.Matcher<T>	isIn(java.util.Collection<? extends T> col, java.util.function.BiPredicate<T,T> matcher) Create a matcher that will check that an item is contained in the specified collection.
static org.hamcrest.Matcher<java.lang.Object>	matches(java.util.regex.Pattern pattern) Create a matcher that will check that string representation of any object matches specified pattern.
static org.hamcrest.Matcher<java.lang.Object>	matches(java.lang.String pattern) Create a matcher that will check that string representation of any object matches specified regexp pattern.
static org.hamcrest.Matcher<java.lang.Throwable>	notExpected() Create a matcher that will check that an exception is null.
static org.hamcrest.Matcher<java.lang.Object>	nullConsistentWith(java.lang.Object value) Create a matcher that will check that tested item and specified value are either both consistently nulls, or both consistently not-nulls.
static <T> org.hamcrest.Matcher<T>	reflectivelyEqualTo(T item) Create a matcher that will check that tested item and specified value are equal according to the ComparisonPerformers.REFLECTIVE_EQUALS performer.
static org.hamcrest.Matcher<java.lang.Throwable>	throwableOfType(java.lang.Class<? extends java.lang.Throwable> type) Create a matcher that will check that an exception is an instance of the specified type.

Methods inherited from class java.lang.Object

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

Method Detail

equalTo

public static <T> org.hamcrest.Matcher<T> equalTo(T item,
                                                  ComparisonPerformer<? super T> performer)

Create a matcher that will check that tested item and specified value are equal according to the specified ComparisonPerformer.

See Also:

deeplyEqualTo(Object), reflectivelyEqualTo(Object), ComparisonMatcher, ComparisonPerformers

deeplyEqualTo

public static <T> org.hamcrest.Matcher<T> deeplyEqualTo(T item)

Create a matcher that will check that tested item and specified value are equal according to the ComparisonPerformers.DEEP_EQUALS performer.

See Also:

equalTo(Object, ComparisonPerformer), reflectivelyEqualTo(Object), ComparisonMatcher, ComparisonPerformers

reflectivelyEqualTo

public static <T> org.hamcrest.Matcher<T> reflectivelyEqualTo(T item)

Create a matcher that will check that tested item and specified value are equal according to the ComparisonPerformers.REFLECTIVE_EQUALS performer.

See Also:

equalTo(Object, ComparisonPerformer), deeplyEqualTo(Object), ComparisonMatcher, ComparisonPerformers

consistentWith

public static <T> org.hamcrest.Matcher<T> consistentWith(T value,
                                                         org.hamcrest.Matcher<? super T> matcher)

Create a matcher that will check that tested item and specified value are either both consistently matched, or both consistently not matched by the specified matcher.

See Also:

nullConsistentWith(Object), ConsistencyMatcher

nullConsistentWith

public static org.hamcrest.Matcher<java.lang.Object> nullConsistentWith(java.lang.Object value)

Create a matcher that will check that tested item and specified value are either both consistently nulls, or both consistently not-nulls.

Equal to consistentWith(Object, Matcher) with Matchers.nullValue() as delegate.

See Also:

ConsistencyMatcher

matches

public static org.hamcrest.Matcher<java.lang.Object> matches(java.lang.String pattern)

Create a matcher that will check that string representation of any object matches specified regexp pattern.

Throws:

java.lang.NullPointerException - if specified string is null

See Also:

matches(Pattern), RegexpMatcher

matches

public static org.hamcrest.Matcher<java.lang.Object> matches(java.util.regex.Pattern pattern)

Create a matcher that will check that string representation of any object matches specified pattern.

Throws:

java.lang.NullPointerException - if specified pattern is null

See Also:

matches(String), RegexpMatcher

throwableOfType

public static org.hamcrest.Matcher<java.lang.Throwable> throwableOfType(java.lang.Class<? extends java.lang.Throwable> type)

Create a matcher that will check that an exception is an instance of the specified type. And will set asserted throwable as cause of the result.

See Also:

notExpected(), ThrowableMatcher

notExpected

public static org.hamcrest.Matcher<java.lang.Throwable> notExpected()

Create a matcher that will check that an exception is null. And will set asserted throwable as cause of the result.

See Also:

throwableOfType(Class), ThrowableMatcher

hasItem

public static <T> org.hamcrest.Matcher<java.util.Collection<? extends T>> hasItem(T item,
                                                                                  java.util.function.BiPredicate<T,T> matcher)

Create a matcher that will check that a collection contains the specified item. Specified predicate is used to check elements equality.

Note: matcher will throw an NPE if matched against a null value!

Throws:

java.lang.NullPointerException - if specified predicate is null

hasAnyItem

public static <T> org.hamcrest.Matcher<java.util.Collection<? extends T>> hasAnyItem(java.util.Collection<T> items)

Equal to hasAnyItem(Collection, BiPredicate) with Objects.deepEquals(Object, Object) used as a predicate.

Note: matcher will throw an NPE if matched against a null value!

Throws:

java.lang.NullPointerException - if specified collection is null

java.lang.IllegalArgumentException - if specified collection is empty

hasAnyItem

public static <T> org.hamcrest.Matcher<java.util.Collection<? extends T>> hasAnyItem(java.util.Collection<T> items,
                                                                                     java.util.function.BiPredicate<T,T> matcher)

Create a matcher that will check that a collection contains any one of the specified item. Specified predicate is used to check elements equality.

Note: matcher will throw an NPE if matched against a null value!

Throws:

java.lang.NullPointerException - if specified collection or specified predicate is null

java.lang.IllegalArgumentException - if specified collection is empty

See Also:

hasAnyItem(Collection)

isIn

public static <T> org.hamcrest.Matcher<T> isIn(java.util.Collection<? extends T> col,
                                               java.util.function.BiPredicate<T,T> matcher)

Create a matcher that will check that an item is contained in the specified collection. Specified predicate is used to check elements equality.

Throws:

java.lang.NullPointerException - if specified collection or predicate is null

convert

public static <T,V> org.hamcrest.Matcher<V> convert(org.hamcrest.Matcher<T> m,
                                                    java.util.function.Function<V,T> f)

Create a matcher that will apply specified function to the received value and then delegate result to the specified matcher delegate.

Throws:

java.lang.NullPointerException - if specified matcher or function is null