com.stafney
Class Hash

java.lang.Object
  |
  +--com.stafney.Hash
All Implemented Interfaces:
java.io.Serializable

public final class Hash
extends java.lang.Object
implements java.io.Serializable

Provides fairly unique immutable hash values for objects wanting to override Object.hashCode(). Please be a good Java programmer and override Object.equals() if you override Object.hashCode().

Since:
1.0
Version:
1.0
Author:
Todd Stafney
See Also:
Serialized Form

Constructor Summary
Hash(boolean arg)
          Construct a Hash from a boolean.
Hash(byte arg)
          Construct a Hash from a byte.
Hash(char arg)
          Construct a Hash from a char.
Hash(int arg)
          Construct a Hash from a int.
Hash(long arg)
          Construct a Hash from a long.
Hash(short arg)
          Construct a Hash from a short.
Hash(java.lang.String arg)
          Construct a Hash from a String.
Hash(java.lang.StringBuffer arg)
          Construct a Hash from a StringBuffer.
 
Method Summary
 byte bag(byte b)
          Convert a Hash to a byte.
 char bag(char b)
          Convert a Hash to a char.
 int bag(int b)
          Convert a Hash to a int.
 long bag(long b)
          Convert a Hash to a long.
 short bag(short b)
          Convert a Hash to a short.
 Hash combine(Hash b)
          Combine two Hash values using strong agglomeration.
 boolean equals(java.lang.Object obj)
           
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Hash

public Hash(boolean arg)
Construct a Hash from a boolean.

Since:
1.0

Hash

public Hash(byte arg)
Construct a Hash from a byte.

Since:
1.0

Hash

public Hash(short arg)
Construct a Hash from a short.

Since:
1.0

Hash

public Hash(char arg)
Construct a Hash from a char.

Since:
1.0

Hash

public Hash(int arg)
Construct a Hash from a int.

Since:
1.0

Hash

public Hash(long arg)
Construct a Hash from a long.

Since:
1.0

Hash

public Hash(java.lang.String arg)
Construct a Hash from a String. Of course String already has a good hashCode so I suppose this is more for completeness.

Since:
1.0

Hash

public Hash(java.lang.StringBuffer arg)
Construct a Hash from a StringBuffer.

Since:
1.0
Method Detail

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
Since:
1.0

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
Since:
1.0

combine

public Hash combine(Hash b)
Combine two Hash values using strong agglomeration.

Parameters:
b - A Hash to combine with this one.
Since:
1.0

bag

public byte bag(byte b)
Convert a Hash to a byte.

Parameters:
b - Conversion seed.
Returns:
The converted Hash.
Since:
1.0

bag

public short bag(short b)
Convert a Hash to a short.

Parameters:
b - Conversion seed.
Returns:
The converted Hash.
Since:
1.0

bag

public char bag(char b)
Convert a Hash to a char.

Parameters:
b - Conversion seed.
Returns:
The converted Hash.
Since:
1.0

bag

public int bag(int b)
Convert a Hash to a int.

Parameters:
b - Conversion seed.
Returns:
The converted Hash.
Since:
1.0

bag

public long bag(long b)
Convert a Hash to a long.

Parameters:
b - Conversion seed.
Returns:
The converted Hash.
Since:
1.0