org.unitils.easymock.util.ReflectionArgumentMatcher Maven / Gradle / Ivy
/*
* Copyright 2008, Unitils.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.unitils.easymock.util;
import org.easymock.internal.matchers.Equals;
import org.unitils.reflectionassert.ReflectionComparator;
import org.unitils.reflectionassert.ReflectionComparatorFactory;
import org.unitils.reflectionassert.ReflectionComparatorMode;
/**
* An easy mock argument matcher to check whether 2 objects are equal by comparing all fields of the objects using
* reflection.
*
* The (combination of) comparator modes specify how strict the comparison must be:
* - ignore defaults: compare only arguments (and inner values) that have a non default value (eg null) as exepected value
* - lenient dates: do not compare actual date values, just that they both have a value or not
* - lenient order: order is not important when comparing collections or arrays
*
*
* @author Tim Ducheyne
* @author Filip Neven
* @see ReflectionComparator
* @see ReflectionComparatorMode
*/
public class ReflectionArgumentMatcher extends Equals {
/***/
private static final long serialVersionUID = 7522941628619033502L;
/* The comparator for lenient comparing expected and actual argument values */
private ReflectionComparator reflectionComparator;
/**
* Creates a matcher for the expected argument value.
* The modes specify how to compare the expected value with the actual value.
*
* @param expected the argument value, not null
* @param modes the comparator modes
*/
public ReflectionArgumentMatcher(T expected, ReflectionComparatorMode... modes) {
super(expected);
this.reflectionComparator = ReflectionComparatorFactory.createRefectionComparator(modes);
}
/**
* Checks whether the given actual value is equal to the expected value.
* A reflection comparator is used to compare both values. The modes determine how
* strict this comparison will be.
*
* An assertion error is thrown if expected and actual did not match. This way, a more
* detailed message can be provided.
*
* @param actual the actual argument value
* @return true
* @throws AssertionError in case expected and actual did not match
*/
@Override
public boolean matches(Object actual) {
return reflectionComparator.isEqual(getExpected(), actual);
}
}