javolution.util.function.EqualityComparer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javolution-core-java-msftbx

Only the Java Core part of Javolution library, with slight modifications for use in MSFTBX.

The newest version!

/*
 * Javolution - Java(TM) Solution for Real-Time and Embedded Systems
 * Copyright (C) 2012 - Javolution (http://javolution.org/)
 * All rights reserved.
 * 
 * Permission to use, copy, modify, and distribute this software is
 * freely granted, provided that this notice is preserved.
 */
package javolution.util.function;


/**
 *  A functional interface to support the comparison of objects 
 *     for equality.
 * 
 * @param  the type of objects that may be compared for equality or order.
 * 
 * @author Jean-Marie Dautelle
 * @version 6.0, July 21, 2013
 * @see Equalities
 */
public interface EqualityComparer  {

    /**
     * Indicates if the specified objects can be considered equal.
     *  
     * @param left the first object (or null).
     * @param right the second object (or null).
     * @return true if both objects are considered equal;
     *         false otherwise. 
     */
    boolean equal(T left, T right);

}