001    /*--------------------------------------------------------------------------+
002    $Id: IEquator.java 26283 2010-02-18 11:18:57Z juergens $
003    |                                                                          |
004    | Copyright 2005-2010 Technische Universitaet Muenchen                     |
005    |                                                                          |
006    | Licensed under the Apache License, Version 2.0 (the "License");          |
007    | you may not use this file except in compliance with the License.         |
008    | You may obtain a copy of the License at                                  |
009    |                                                                          |
010    |    http://www.apache.org/licenses/LICENSE-2.0                            |
011    |                                                                          |
012    | Unless required by applicable law or agreed to in writing, software      |
013    | distributed under the License is distributed on an "AS IS" BASIS,        |
014    | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
015    | See the License for the specific language governing permissions and      |
016    | limitations under the License.                                           |
017    +--------------------------------------------------------------------------*/
018    package edu.tum.cs.commons.equals;
019    
020    /**
021     * Compares two elements for equality.
022     * <p>
023     * This interface externalizes the notion of equality. This way, different
024     * notions of equality can be applied to the same object in different contexts.
025     * 
026     * @author Elmar Juergens
027     * @author $Author: juergens $
028     * 
029     * @version $Revision: 26283 $
030     * @levd.rating GREEN Hash: 3B8AE0E21829588480F73AD24647C588
031     */
032    public interface IEquator<T> {
033    
034            /**
035             * Returns <code>true</code>, if the elements are equal,
036             * <code>false</code> if not.
037             */
038            public boolean equals(T element1, T element2);
039    
040    }