org.exparity.hamcrest.BeanMatchers Maven / Gradle / Ivy

Go to download

package org.exparity.hamcrest;

import org.exparity.hamcrest.beans.HasPath;
import org.exparity.hamcrest.beans.HasProperty;
import org.exparity.hamcrest.beans.TheSameAs;
import org.hamcrest.Matcher;

/**
 * Static factory for creating {@link Matcher} instances for testing properties of objects whose properties follow the Java beans standard
 * 
 * @author Stewart Bissett
 */
public abstract class BeanMatchers {

	/**
	 * Return an instance of a {@link 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"));
	 * 
	 * @param object the instance to match against
	 * @param  the type of the instance
	 * @return an intstance of TheSameAs matcher
	 */
	public static  TheSameAs theSameAs(final T object) {
		return TheSameAs.theSameAs(object);
	}

	/**
	 * Return an instance of a {@link 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"));
	 * 
	 * @param object the instance to match against
	 * @param name the name to use for the base object for paths e.g Person would prefix path i.e. Person.FirstName
	 * @param  the type of the instance
	 * @return an intstance of TheSameAs matcher
	 */
	public static  TheSameAs theSameAs(final T object, final String name) {
		return TheSameAs.theSameAs(object, name);
	}

	/**
	 * Return an instance of a {@link 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")))
	 * 
	 * 
	 * @param name the name of the property
	 * @param matcher the matcher to test the value of the property
	 * @param  the type of the instance
	 * @return an instance of a Matcher
	 */
	public static  Matcher hasProperty(final String name, final Matcher matcher) {
		return HasProperty. hasProperty(name, matcher);
	}

	/**
	 * Return an instance of a {@link 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")))
	 * 
	 * 
	 * @param path the name of the path
	 * @param matcher the matcher to test the value of the path
	 * @param  the type of the instance
	 * @return an instance of a Matcher
	 */
	public static  Matcher hasPath(final String name, final Matcher matcher) {
		return HasPath. hasPath(name, matcher);
	}
}