ext.test4j.hamcrest.core.Is Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of test4j.nodep Show documentation

There is a newer version: 2.5.0

package ext.test4j.hamcrest.core;

import ext.test4j.hamcrest.BaseMatcher;
import ext.test4j.hamcrest.Description;
import ext.test4j.hamcrest.Factory;
import ext.test4j.hamcrest.Matcher;

import static ext.test4j.hamcrest.core.IsEqual.equalTo;
import static ext.test4j.hamcrest.core.IsInstanceOf.instanceOf;

/**
 * Decorates another Matcher, retaining the behavior but allowing tests to be
 * slightly more expressive.
 * 
 * For example: assertThat(cheese, equalTo(smelly)) vs. assertThat(cheese,
 * is(equalTo(smelly)))
 */
public class Is extends BaseMatcher {
	private final Matcher matcher;

	public Is(Matcher matcher) {
		this.matcher = matcher;
	}

	public boolean matches(Object arg) {
		return matcher.matches(arg);
	}

	public void describeTo(Description description) {
		description.appendText("is ").appendDescriptionOf(matcher);
	}

	@Override
	public void describeMismatch(Object item, Description mismatchDescription) {
		// TODO(ngd): unit tests....
		matcher.describeMismatch(item, mismatchDescription);
	}

	/**
	 * Decorates another Matcher, retaining the behavior but allowing tests to
	 * be slightly more expressive.
	 * 
	 * For example: assertThat(cheese, equalTo(smelly)) vs. assertThat(cheese,
	 * is(equalTo(smelly)))
	 */
	@Factory
	public static  Matcher is(Matcher matcher) {
		return new Is(matcher);
	}

	/**
	 * This is a shortcut to the frequently used is(equalTo(x)).
	 * 
	 * For example: assertThat(cheese, is(equalTo(smelly))) vs.
	 * assertThat(cheese, is(smelly))
	 */
	@Factory
	public static  Matcher is(T value) {
		return is(equalTo(value));
	}

	@Factory
	// @Deprecated
	public static  Matcher isA(Class type) {
		final Matcher typeMatcher = instanceOf(type);
		return is(typeMatcher);
	}
}