es.uvigo.esei.dgss.letta.domain.entities

Class IsEqualsToEntity<T>

java.lang.Object

org.hamcrest.BaseMatcher<T>

org.hamcrest.TypeSafeMatcher<T>

es.uvigo.esei.dgss.letta.domain.entities.IsEqualsToEntity<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:

IsEqualsToRegistration, IsEqualsToUser, IsEqualToEvent

public abstract class IsEqualsToEntity<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
IsEqualsToEntity(T entity) Constructs a new instance of IsEqualsToEntity.

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	checkAttribute(String attribute, Function<T,R> getter, T actual) Compares the expected and the actual value of an 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, T... entities) Utility method that generates a Matcher that compares several entities.
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

IsEqualsToEntity

public IsEqualsToEntity(T entity)

Constructs a new instance of IsEqualsToEntity.

Parameters:

entity - the expected tentity.

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)

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.

containsEntityInAnyOrder

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

Utility method that generates a Matcher that compares several entities.

Type Parameters:

T - type of the entity.

Parameters:

converter - a function to create a matcher for an entity.

entities - the entities to be used as the expected values.

Returns:

a new Matcher that compares several entities.