KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > bak > pcj > hash > ByteHashFunction


1 /*
2  * Primitive Collections for Java.
3  * Copyright (C) 2002 Søren Bak
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 package bak.pcj.hash;
20
21 /**
22  * This interface represents hash functions from byte values
23  * to int values. The int value result is chosen to achieve
24  * consistence with the common
25  * {@link Object#hashCode() hashCode()}
26  * method. The interface is provided to alter the hash functions used
27  * by hashing data structures, like
28  * {@link bak.pcj.map.ByteKeyIntChainedHashMap ByteKeyIntChainedHashMap}
29  * or
30  * {@link bak.pcj.set.ByteChainedHashSet ByteChainedHashSet}.
31  *
32  * @see DefaultByteHashFunction
33  *
34  * @author Søren Bak
35  * @version 1.0 2002/29/12
36  * @since 1.0
37  */
38 public interface ByteHashFunction {
39
40     /**
41      * Returns a hash code for a specified byte value.
42      *
43      * @param v
44      * the value for which to return a hash code.
45      *
46      * @return a hash code for the specified value.
47      */
48     int hash(byte v);
49
50 }
Popular Tags