org.unitils.mock.argumentmatcher.impl.RefEqArgumentMatcher Maven / Gradle / Ivy
/*
*
* * Copyright 2010, 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.mock.argumentmatcher.impl;
import org.unitils.mock.argumentmatcher.ArgumentMatcher;
import org.unitils.reflectionassert.ReflectionComparator;
import static org.unitils.mock.argumentmatcher.ArgumentMatcher.MatchResult.MATCH;
import static org.unitils.mock.argumentmatcher.ArgumentMatcher.MatchResult.NO_MATCH;
import static org.unitils.mock.core.proxy.CloneUtil.createDeepClone;
import static org.unitils.reflectionassert.ReflectionComparatorFactory.createRefectionComparator;
/**
* A matcher for checking whether an argument equals a given value.
* Reflection is used to compare all fields of these values.
*
* @author Kenny Claes
* @author Filip Neven
* @author Tim Ducheyne
*/
public class RefEqArgumentMatcher implements ArgumentMatcher {
/* The expected value */
private final Object value;
/**
* Creates a matcher for the given value. A copy of the value is taken so that it can be compared
* even when the value itself was modified later-on.
*
* @param value The expected value
*/
public RefEqArgumentMatcher(Object value) {
this.value = createDeepClone(value);
}
/**
* Returns true if the given object matches the expected argument, false otherwise.
*
* The argumentAtInvocationTime is a copy (deep clone) of the arguments at the time of
* the invocation. This way the original values can still be used later-on even when changes
* occur to the original values (pass-by-value vs pass-by-reference).
*
* @param argument The argument that were used by reference, not null
* @param argumentAtInvocationTime Copy of the argument, taken at the time that the invocation was performed, not null
* @return The match result, not null
*/
public MatchResult matches(Object argument, Object argumentAtInvocationTime) {
ReflectionComparator reflectionComparator = createRefectionComparator();
if (reflectionComparator.isEqual(value, argumentAtInvocationTime)) {
return MATCH;
}
return NO_MATCH;
}
}