01: ///////////////////////////////////////////////////////////////////////////////
02: // Copyright (c) 2002, Eric D. Friedman All Rights Reserved.
03: //
04: // This library is free software; you can redistribute it and/or
05: // modify it under the terms of the GNU Lesser General Public
06: // License as published by the Free Software Foundation; either
07: // version 2.1 of the License, or (at your option) any later version.
08: //
09: // This library is distributed in the hope that it will be useful,
10: // but WITHOUT ANY WARRANTY; without even the implied warranty of
11: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: // GNU General Public License for more details.
13: //
14: // You should have received a copy of the GNU Lesser General Public
15: // License along with this program; if not, write to the Free Software
16: // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17: ///////////////////////////////////////////////////////////////////////////////
18:
19: package gnu.trove;
20:
21: import java.io.Serializable;
22:
23: /**
24: * Interface to support pluggable hashing strategies in maps and sets.
25: * Implementors can use this interface to make the trove hashing
26: * algorithms use object values, values provided by the java runtime,
27: * or a custom strategy when computing hashcodes.
28: *
29: * Created: Sat Aug 17 10:52:32 2002
30: *
31: * @author Eric Friedman
32: * @version $Id: TObjectHashingStrategy.java,v 1.3 2007/06/11 15:26:44 robeden Exp $
33: */
34:
35: public interface TObjectHashingStrategy<T> extends Serializable {
36:
37: /**
38: * Computes a hash code for the specified object. Implementors
39: * can use the object's own <tt>hashCode</tt> method, the Java
40: * runtime's <tt>identityHashCode</tt>, or a custom scheme.
41: *
42: * @param object for which the hashcode is to be computed
43: * @return the hashCode
44: */
45: int computeHashCode(T object);
46:
47: /**
48: * Compares o1 and o2 for equality. Strategy implementors may use
49: * the objects' own equals() methods, compare object references,
50: * or implement some custom scheme.
51: *
52: * @param o1 an <code>Object</code> value
53: * @param o2 an <code>Object</code> value
54: * @return true if the objects are equal according to this strategy.
55: */
56: boolean equals(T o1, T o2);
57: } // TObjectHashingStrategy
|