org.whaka.util.reflection.comparison

Interface ComparisonPerformer<T>

All Superinterfaces:

java.util.function.BiFunction<T,T,ComparisonResult>, java.util.function.BiPredicate<T,T>

All Known Implementing Classes:

AbstractComparisonPerformer, ArrayComparisonPerformer, CompositeComparisonPerformer, DynamicComparisonPerformer, ListComparisonPerformer, MapComparisonPerformer, ReflectiveComparisonPerformer, SetComparisonPerformer

public interface ComparisonPerformer<T>
extends java.util.function.BiFunction<T,T,ComparisonResult>, java.util.function.BiPredicate<T,T>

Comparison performer represents both a BiFunction that converts two instances of the same type into a ComparisonResult, and a BiPredicate that converts two instances of the same type into a boolean answer.

Main function of a performer is to perform some complex comparison and to provide a proper extended result. But sometimes there's no need for a result like this, and a simple "yes/no" answer will suffice. For case like this it is also a predicate.

Note: there's a default implementation of the test(Object, Object) method that simply calls apply(Object, Object) and then checks received result for success. But more complex performers might also override it and provide it's own implementation, for example to limit some costly operations, required for a more extended compare.

Method Summary

Modifier and Type	Method and Description
ComparisonResult	apply(T actual, T expected)
default java.lang.String	getName() Used to identify performer in a result.
default boolean	test(T a, T b) May be used in case simple yes/no answer is enough and there's no need for extended ComparisonResult.

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface java.util.function.BiPredicate

and, negate, or

Method Detail

apply

ComparisonResult apply(T actual,
                       T expected)

Specified by:

apply in interface java.util.function.BiFunction<T,T,ComparisonResult>

test

default boolean test(T a,
                     T b)

May be used in case simple yes/no answer is enough and there's no need for extended ComparisonResult. Note: by default this method just calls apply(Object, Object) and checks result for success.

Specified by:

test in interface java.util.function.BiPredicate<T,T>

See Also:

apply(Object, Object)

getName

default java.lang.String getName()

Used to identify performer in a result. Recommended to return human readable ID of the performer