001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.hivemind.test;
016    
017    /**
018     * Used with {@link org.apache.hivemind.test.AggregateArgumentsMatcher} to provide matching logic
019     * for a single argument.
020     * 
021     * @author Howard M. Lewis Ship
022     * @since 1.1
023     */
024    public interface ArgumentMatcher
025    {
026        /**
027         * Compares an expected argument value (provided when training the mock object), against the
028         * actual argument value. This method is only invoked if both arguments are non-null and not the
029         * same object (based on identity comparison, not <code>equals()</code>).
030         * 
031         * @param expected
032         *            The expected argument value
033         * @param actual
034         *            The actual argument value
035         * @return true if the two objects can be considered the same, false otherwise.
036         */
037    
038        public boolean compareArguments(Object expected, Object actual);
039    }