es.uvigo.esei.dgss.teama.microstories.entities

Class IsEqualToEntity<T>

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeMatcher<T>

es.uvigo.esei.dgss.teama.microstories.entities.IsEqualToEntity<T>

Type Parameters:

T - the type of the entities to be matched.

All Implemented Interfaces:

org.hamcrest.Matcher<T>, org.hamcrest.SelfDescribing

Direct Known Subclasses:

IsEqualToStory

public abstract class IsEqualToEntity<T>
extends org.hamcrest.TypeSafeMatcher<T>

An abstract Matcher that can be used to create new matchers that compare entities by their attributes.

Author:

Miguel Reboiro Jato

Field Summary

Fields

Modifier and Type	Field and Description
protected T	expected The expected entity.

Constructor Summary

Constructors

Constructor and Description
IsEqualToEntity(T entity) Constructs a new instance of IsEqualToEntity.

Method Summary

Modifier and Type	Method and Description
protected void	addMatcherDescription(org.hamcrest.Matcher<?> matcher) Adds as the description of this matcher the SelfDescribing.describeTo(Description) method of other matcher.
protected void	addTemplatedDescription(String attribute, Object expected) Adds a new description using the template:
protected <R> boolean	checkArrayAttribute(String attribute, Function<T,R[]> getter, T actual) Compares the expected and the actual value of an array attribute.
protected <R> boolean	checkArrayAttribute(String attribute, Function<T,R[]> getter, T actual, Function<R[],org.hamcrest.Matcher<Iterable<? extends R>>> matcherFactory) Compares the expected and the actual value of an array attribute.
protected <R> boolean	checkAttribute(String attribute, Function<T,R> getter, T actual) Compares the expected and the actual value of an attribute.
protected <R> boolean	checkAttribute(String attribute, Function<T,R> getter, T actual, Function<R,org.hamcrest.Matcher<R>> matcherFactory)
protected boolean	checkIntArrayAttribute(String attribute, Function<T,int[]> getter, T actual) Compares the expected and the actual value of an int array attribute.
protected <R> boolean	checkIterableAttribute(String attribute, Function<T,Iterable<R>> getter, T actual, Function<Iterable<R>,org.hamcrest.Matcher<Iterable<? extends R>>> matcherFactory) Compares the expected and the actual value of an iterable attribute.
protected void	clearDescribeTo() Cleans the current description.
protected static <T> org.hamcrest.Matcher<Iterable<? extends T>>	containsEntityInAnyOrder(Function<T,org.hamcrest.Matcher<? super T>> converter, Iterable<T> entities) Generates a Hamcrest matcher that compares an Iterable of entities in **any order**.
protected static <T> org.hamcrest.Matcher<Iterable<? extends T>>	containsEntityInAnyOrder(Function<T,org.hamcrest.Matcher<? super T>> converter, T... entities) Generates a Hamcrest matcher that compares an array of entities in **any order**.
protected static <T> org.hamcrest.Matcher<Iterable<? extends T>>	containsEntityInOrder(Function<T,org.hamcrest.Matcher<? super T>> converter, Iterable<T> entities) Generates a Hamcrest matcher that compares an Iterable of entities in **the given order**.
protected static <T> org.hamcrest.Matcher<Iterable<? extends T>>	containsEntityInOrder(Function<T,org.hamcrest.Matcher<? super T>> converter, T... entities) Generates a Hamcrest matcher that compares an array of entities in **the given order**.
void	describeTo(org.hamcrest.Description description)

Methods inherited from class org.hamcrest.TypeSafeMatcher

describeMismatch, describeMismatchSafely, matches, matchesSafely

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, toString

Methods inherited from class java.lang.Object

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

Field Detail

expected

protected final T expected

The expected entity.

Constructor Detail

IsEqualToEntity

public IsEqualToEntity(T entity)

Constructs a new instance of IsEqualToEntity.

Parameters:

entity - the expected entity.

Method Detail

describeTo

public void describeTo(org.hamcrest.Description description)

addTemplatedDescription

protected void addTemplatedDescription(String attribute,
                                       Object expected)

Adds a new description using the template:

<expected class> entity with value '<expected>' for <attribute>

Parameters:

attribute - the name of the attribute compared.

expected - the expected value.

addMatcherDescription

protected void addMatcherDescription(org.hamcrest.Matcher<?> matcher)

Adds as the description of this matcher the SelfDescribing.describeTo(Description) method of other matcher.

Parameters:

matcher - the matcher whose description will be used.

clearDescribeTo

protected void clearDescribeTo()

Cleans the current description.

checkAttribute

protected <R> boolean checkAttribute(String attribute,
                                     Function<T,R> getter,
                                     T actual,
                                     Function<R,org.hamcrest.Matcher<R>> matcherFactory)

checkArrayAttribute

protected <R> boolean checkArrayAttribute(String attribute,
                                          Function<T,R[]> getter,
                                          T actual,
                                          Function<R[],org.hamcrest.Matcher<Iterable<? extends R>>> matcherFactory)

Compares the expected and the actual value of an array attribute. The elements of the attribute will be checked using a custom matcher. If the comparison fails, the description of the error will be updated.

Type Parameters:

R - type of the value returned by the getter.

Parameters:

attribute - the name of the attribute compared.

getter - the getter function of the attribute.

actual - the actual entity being compared to the expected entity.

matcherFactory - a function that creates a matcher for the expected array values.

Returns:

true if the value of the expected and actual attributes are equals and false otherwise. If the result is false, the current description will be updated.

checkIterableAttribute

protected <R> boolean checkIterableAttribute(String attribute,
                                             Function<T,Iterable<R>> getter,
                                             T actual,
                                             Function<Iterable<R>,org.hamcrest.Matcher<Iterable<? extends R>>> matcherFactory)

Compares the expected and the actual value of an iterable attribute. The elements of the attribute will be checked using a custom matcher. If the comparison fails, the description of the error will be updated.

Type Parameters:

R - type of the value returned by the getter.

Parameters:

attribute - the name of the attribute compared.

getter - the getter function of the attribute.

actual - the actual entity being compared to the expected entity.

matcherFactory - a function that creates a matcher for the expected iterable values.

Returns:

true if the value of the expected and actual attributes are equals and false otherwise. If the result is false, the current description will be updated.

checkAttribute

protected <R> boolean checkAttribute(String attribute,
                                     Function<T,R> getter,
                                     T actual)

Compares the expected and the actual value of an attribute. If the comparison fails, the description of the error will be updated.

Type Parameters:

R - type of the value returned by the getter.

Parameters:

attribute - the name of the attribute compared.

getter - the getter function of the attribute.

actual - the actual entity being compared to the expected entity.

Returns:

true if the value of the expected and actual attributes are equals and false otherwise. If the result is false, the current description will be updated.

checkArrayAttribute

protected <R> boolean checkArrayAttribute(String attribute,
                                          Function<T,R[]> getter,
                                          T actual)

Compares the expected and the actual value of an array attribute. If the comparison fails, the description of the error will be updated.

Type Parameters:

R - type of the value returned by the getter.

Parameters:

attribute - the name of the attribute compared.

getter - the getter function of the attribute.

actual - the actual entity being compared to the expected entity.

Returns:

true if the value of the expected and actual attributes are equals and false otherwise. If the result is false, the current description will be updated.

checkIntArrayAttribute

protected boolean checkIntArrayAttribute(String attribute,
                                         Function<T,int[]> getter,
                                         T actual)

Compares the expected and the actual value of an int array attribute. If the comparison fails, the description of the error will be updated.

Parameters:

attribute - the name of the attribute compared.

getter - the getter function of the attribute.

actual - the actual entity being compared to the expected entity.

Returns:

true if the value of the expected and actual attributes are equals and false otherwise. If the result is false, the current description will be updated.

containsEntityInAnyOrder

protected static <T> org.hamcrest.Matcher<Iterable<? extends T>> containsEntityInAnyOrder(Function<T,org.hamcrest.Matcher<? super T>> converter,
                                                                                          Iterable<T> entities)

Generates a Hamcrest matcher that compares an Iterable of entities in **any order**.

Each entity in the entities collection is converted to a matcher using the provided converter function. The resulting matcher will succeed if the actual Iterable contains all expected entities, regardless of order.

Type Parameters:

T - the type of the entities being compared

Parameters:

converter - a function that converts each entity to a Matcher for comparison

entities - the expected entities to match

Returns:

a Matcher that verifies the actual Iterable contains the expected entities in any order

containsEntityInAnyOrder

@SafeVarargs
protected static <T> org.hamcrest.Matcher<Iterable<? extends T>> containsEntityInAnyOrder(Function<T,org.hamcrest.Matcher<? super T>> converter,
                                                                                                       T... entities)

Generates a Hamcrest matcher that compares an array of entities in **any order**.

Each entity in the entities array is converted to a matcher using the provided converter function. The resulting matcher will succeed if the actual Iterable contains all expected entities, regardless of order.

Type Parameters:

T - the type of the entities being compared

Parameters:

converter - a function that converts each entity to a Matcher for comparison

entities - the expected entities to match (varargs)

Returns:

a Matcher that verifies the actual Iterable contains the expected entities in any order

containsEntityInOrder

protected static <T> org.hamcrest.Matcher<Iterable<? extends T>> containsEntityInOrder(Function<T,org.hamcrest.Matcher<? super T>> converter,
                                                                                       Iterable<T> entities)

Generates a Hamcrest matcher that compares an Iterable of entities in **the given order**.

Each entity in the entities collection is converted to a matcher using the provided converter function. The resulting matcher will succeed only if the actual Iterable contains the expected entities in the same order.

Type Parameters:

T - the type of the entities being compared

Parameters:

converter - a function that converts each entity to a Matcher for comparison

entities - the expected entities to match

Returns:

a Matcher that verifies the actual Iterable contains the expected entities in order

containsEntityInOrder

@SafeVarargs
protected static <T> org.hamcrest.Matcher<Iterable<? extends T>> containsEntityInOrder(Function<T,org.hamcrest.Matcher<? super T>> converter,
                                                                                                    T... entities)

Generates a Hamcrest matcher that compares an array of entities in **the given order**.

Each entity in the entities array is converted to a matcher using the provided converter function. The resulting matcher will succeed only if the actual Iterable contains the expected entities in the same order.

Type Parameters:

T - the type of the entities being compared

Parameters:

converter - a function that converts each entity to a Matcher for comparison

entities - the expected entities to match (varargs)

Returns:

a Matcher that verifies the actual Iterable contains the expected entities in order