net.sf.mmm.util.lang.api

Class AbstractHashCodeFunction<VALUE>

java.lang.Object

net.sf.mmm.util.lang.api.AbstractHashCodeFunction<VALUE>

Type Parameters:

VALUE - is the generic type of the objects to hash.

All Implemented Interfaces:

HashCodeFunction<VALUE>

Direct Known Subclasses:

HashCodeFunctionDefault, HashCodeFunctionSystemIdentity

public abstract class AbstractHashCodeFunction<VALUE>
extends Object
implements HashCodeFunction<VALUE>

This is the abstract base implementation of HashCodeFunction. It contains the handling of null values.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
AbstractHashCodeFunction() The constructor.

Method Summary

Modifier and Type	Method and Description
int	hashCode(VALUE value)
protected abstract int	hashCodeNotNull(VALUE value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractHashCodeFunction

public AbstractHashCodeFunction()

The constructor.

Method Detail

hashCode

public int hashCode(VALUE value)

Specified by:

hashCode in interface HashCodeFunction<VALUE>

Parameters:

value - is the object to hash.

Returns:

the custom hash code of the given value. The default implementation will simply return value.hashCode().

hashCodeNotNull

protected abstract int hashCodeNotNull(VALUE value)

Parameters:

value - is the object to hash. Will NOT be null.

Returns:

the custom hash code of the given value.

See Also:

hashCode(Object)