soot.EquivTo Maven / Gradle / Ivy
package soot;
/*-
* #%L
* Soot - a J*va Optimization Framework
* %%
* Copyright (C) 1997 - 1999 Raja Vallee-Rai
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 2.1 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
/**
* An alternate equivalence relation between objects. The standard interpretation will be structural equality. We also demand
* that if x.equivTo(y), then x.equivHashCode() == y.equivHashCode.
*/
public interface EquivTo {
/** Returns true if this object is equivalent to o. */
public boolean equivTo(Object o);
/**
* Returns a (not necessarily fixed) hash code for this object. This hash code coincides with equivTo; it is undefined in
* the presence of mutable objects.
*/
public int equivHashCode();
}