org.exparity.hamcrest

Class BeanMatchers

java.lang.Object

org.exparity.hamcrest.BeanMatchers

public abstract class BeanMatchers
extends Object

Static factory for creating Matcher instances for testing properties of objects whose properties follow the Java beans standard

Author:

Stewart Bissett

Constructor Summary

Constructors

Constructor and Description
BeanMatchers()

Method Summary

Modifier and Type	Method and Description
static <T> org.hamcrest.Matcher<T>	hasPath(String name, org.hamcrest.Matcher<?> matcher) Return an instance of a Matcher which will test if an object has a named path with the given value.
static <T> org.hamcrest.Matcher<T>	hasProperty(String name, org.hamcrest.Matcher<?> matcher) Return an instance of a Matcher which will test if an object has a named property with the given value.
static <T> TheSameAs<T>	theSameAs(T object) Return an instance of a Matcher which will perform a deep comparison of the two objects.
static <T> TheSameAs<T>	theSameAs(T object, String name) Return an instance of a Matcher which will perform a deep comparison of the two objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanMatchers

public BeanMatchers()

Method Detail

theSameAs

public static <T> TheSameAs<T> theSameAs(T object)

Return an instance of a Matcher which will perform a deep comparison of the two objects. For Example

 class Person [
   private String firstName, lastName;
   public Person(final String firstName, final String lastName) {
     this.firstname = firstName;
     this.lastName = lastName;
    }
    public String getFirstName() { return firstName;};
    public String getLastName() { return lastName;};
 }
 
 // To test a simple object
 Person expected = new Person("John", "Doe");
 assertThat(new Person("John", "Doe"), theSameAs(expected))
 
 // To test a simple object but ignore differences in a property
 Person expected = new Person("Jane", "Doe");
 assertThat(new Person("John", "Doe"), theSameAs(expected).excludeProperty("FirstName"));
 

Type Parameters:

T - the type of the instance

Parameters:

object - the instance to match against

Returns:

an intstance of TheSameAs matcher

theSameAs

public static <T> TheSameAs<T> theSameAs(T object,
                                         String name)

Return an instance of a Matcher which will perform a deep comparison of the two objects. For Example

 class Person [
   private String firstName, lastName;
   public Person(final String firstName, final String lastName) {
     this.firstname = firstName;
     this.lastName = lastName;
    }
    public String getFirstName() { return firstName;};
    public String getLastName() { return lastName;};
 }
 
 // To test a simple object
 Person expected = new Person("John", "Doe");
 assertThat(new Person("John", "Doe"), theSameAs(expected, "Person"))
 
 // To test a simple object but ignore differences in a property
 Person expected = new Person("Jane", "Doe");
 assertThat(new Person("John", "Doe"), theSameAs(expected,"Person").excludePath("Person.FirstName"));
 

Type Parameters:

T - the type of the instance

Parameters:

object - the instance to match against

name - the name to use for the base object for paths e.g Person would prefix path i.e. Person.FirstName

Returns:

an intstance of TheSameAs matcher

hasProperty

public static <T> org.hamcrest.Matcher<T> hasProperty(String name,
                                                      org.hamcrest.Matcher<?> matcher)

Return an instance of a Matcher which will test if an object has a named property with the given value. For Example

 class Person [
   private String firstName, lastName;
   public Person(final String firstName, final String lastName) {
     this.firstname = firstName;
     this.lastName = lastName;
    }
    public String getFirstName() { return firstName;};
    public String getLastName() { return lastName;};
 }
 
 // To test a simple object
 Person expected = new Person("John", "Doe");
 assertThat(new Person("John", "Doe"), hasProperty("FirstName, equalTo("John")))
 
 

Type Parameters:

T - the type of the instance

Parameters:

name - the name of the property

matcher - the matcher to test the value of the property

Returns:

an instance of a Matcher

hasPath

public static <T> org.hamcrest.Matcher<T> hasPath(String name,
                                                  org.hamcrest.Matcher<?> matcher)

Return an instance of a Matcher which will test if an object has a named path with the given value. For Example

 class Person [
   private String firstName, lastName;
   public Person(final String firstName, final String lastName) {
     this.firstname = firstName;
     this.lastName = lastName;
    }
    public String getFirstName() { return firstName;};
    public String getLastName() { return lastName;};
 }
 
 // To test a simple object
 Person expected = new Person("John", "Doe");
 assertThat(new Person("John", "Doe"), hasProperty("Person.FirstName, equalTo("John")))
 
 

Type Parameters:

T - the type of the instance

Parameters:

path - the name of the path

matcher - the matcher to test the value of the path

Returns:

an instance of a Matcher