Class HashCodeBuilder
- java.lang.Object
-
- org.apache.commons.lang3.builder.AbstractReflection
-
- org.apache.commons.lang3.builder.HashCodeBuilder
-
- All Implemented Interfaces:
Builder<java.lang.Integer>
public class HashCodeBuilder extends AbstractReflection implements Builder<java.lang.Integer>
Assists in implementingObject.hashCode()methods.This class enables a good
hashCodemethod to be built for any class. It follows the rules laid out in the book Effective Java by Joshua Bloch. Writing a goodhashCodemethod is actually quite difficult. This class aims to simplify the process.The following is the approach taken. When appending a data field, the current total is multiplied by the multiplier then a relevant value for that data type is added. For example, if the current hashCode is 17, and the multiplier is 37, then appending the integer 45 will create a hash code of 674, namely 17 * 37 + 45.
All relevant fields from the object should be included in the
hashCodemethod. Derived fields may be excluded. In general, any field used in theequalsmethod must be used in thehashCodemethod.To use this class write code as follows:
public class Person { String name; int age; boolean smoker; ... public int hashCode() { // you pick a hard-coded, randomly chosen, non-zero, odd number // ideally different for each class return new HashCodeBuilder(17, 37). append(name). append(age). append(smoker). toHashCode(); } }If required, the superclass
hashCode()can be added usingappendSuper(int).Alternatively, there is a method that uses reflection to determine the fields to test. Because these fields are usually private, the method,
reflectionHashCode, usesAccessibleObject.setAccessibleto change the visibility of the fields. This will fail under a security manager, unless the appropriate permissions are set up correctly. It is also slower than testing explicitly.See also
AbstractReflection.AbstractBuilder.setForceAccessible(boolean)A typical invocation for this method would look like:
public int hashCode() { return HashCodeBuilder.reflectionHashCode(this); }The
HashCodeExcludeannotation can be used to exclude fields from being used by thereflectionHashCodemethods.- Since:
- 1.0
- See Also:
AbstractReflection.AbstractBuilder.setForceAccessible(boolean)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classHashCodeBuilder.BuilderBuilds instances of CompareToBuilder.-
Nested classes/interfaces inherited from class org.apache.commons.lang3.builder.AbstractReflection
AbstractReflection.AbstractBuilder<B extends AbstractReflection.AbstractBuilder<B>>
-
-
Constructor Summary
Constructors Constructor Description HashCodeBuilder()Uses two hard coded choices for the constants needed to build ahashCode.HashCodeBuilder(int initialOddNumber, int multiplierOddNumber)Two randomly chosen, odd numbers must be passed in.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HashCodeBuilderappend(boolean value)Appends ahashCodefor aboolean.HashCodeBuilderappend(boolean[] array)Appends ahashCodefor abooleanarray.HashCodeBuilderappend(byte value)Appends ahashCodefor abyte.HashCodeBuilderappend(byte[] array)Appends ahashCodefor abytearray.HashCodeBuilderappend(char value)Appends ahashCodefor achar.HashCodeBuilderappend(char[] array)Appends ahashCodefor achararray.HashCodeBuilderappend(double value)Appends ahashCodefor adouble.HashCodeBuilderappend(double[] array)Appends ahashCodefor adoublearray.HashCodeBuilderappend(float value)Appends ahashCodefor afloat.HashCodeBuilderappend(float[] array)Appends ahashCodefor afloatarray.HashCodeBuilderappend(int value)Appends ahashCodefor anint.HashCodeBuilderappend(int[] array)Appends ahashCodefor anintarray.HashCodeBuilderappend(long value)Appends ahashCodefor along.HashCodeBuilderappend(long[] array)Appends ahashCodefor alongarray.HashCodeBuilderappend(short value)Appends ahashCodefor ashort.HashCodeBuilderappend(short[] array)Appends ahashCodefor ashortarray.HashCodeBuilderappend(java.lang.Object object)Appends ahashCodefor anObject.HashCodeBuilderappend(java.lang.Object[] array)Appends ahashCodefor anObjectarray.HashCodeBuilderappendSuper(int superHashCode)Adds the result of super.hashCode() to this builder.java.lang.Integerbuild()Returns the computedhashCode.static HashCodeBuilder.Builderbuilder()Constructs a new Builder.booleanequals(java.lang.Object obj)Implements equals using the hash code.inthashCode()Returns the computedhashCodefromtoHashCode()due to the likelihood of bugs in mis-callingtoHashCode()and the unlikeliness of it mattering what the hashCode forHashCodeBuilderitself is.static intreflectionHashCode(int initialNonZeroOddNumber, int multiplierNonZeroOddNumber, java.lang.Object object)Uses reflection to build a valid hash code from the fields ofobject.static intreflectionHashCode(int initialNonZeroOddNumber, int multiplierNonZeroOddNumber, java.lang.Object object, boolean testTransients)Uses reflection to build a valid hash code from the fields ofobject.static <T> intreflectionHashCode(int initialNonZeroOddNumber, int multiplierNonZeroOddNumber, T object, boolean testTransients, java.lang.Class<? super T> reflectUpToClass, java.lang.String... excludeFields)Uses reflection to build a valid hash code from the fields ofobject.static intreflectionHashCode(java.lang.Object object, boolean testTransients)Uses reflection to build a valid hash code from the fields ofobject.static intreflectionHashCode(java.lang.Object object, java.lang.String... excludeFields)Uses reflection to build a valid hash code from the fields ofobject.static intreflectionHashCode(java.lang.Object object, java.util.Collection<java.lang.String> excludeFields)Uses reflection to build a valid hash code from the fields ofobject.inttoHashCode()Returns the computedhashCode.-
Methods inherited from class org.apache.commons.lang3.builder.AbstractReflection
getForceAccessible, isForceAccessible, setAccessible
-
-
-
-
Constructor Detail
-
HashCodeBuilder
public HashCodeBuilder()
Uses two hard coded choices for the constants needed to build ahashCode.
-
HashCodeBuilder
public HashCodeBuilder(int initialOddNumber, int multiplierOddNumber)Two randomly chosen, odd numbers must be passed in. Ideally these should be different for each class, however this is not vital.Prime numbers are preferred, especially for the multiplier.
- Parameters:
initialOddNumber- an odd number used as the initial valuemultiplierOddNumber- an odd number used as the multiplier- Throws:
java.lang.IllegalArgumentException- Thrown if the number is even.
-
-
Method Detail
-
builder
public static HashCodeBuilder.Builder builder()
Constructs a new Builder.- Returns:
- A new Builder.
-
reflectionHashCode
public static int reflectionHashCode(int initialNonZeroOddNumber, int multiplierNonZeroOddNumber, java.lang.Object object)Uses reflection to build a valid hash code from the fields ofobject.It uses
AccessibleObject.setAccessibleto gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.Transient members will be not be used, as they are likely derived fields, and not part of the value of the
Object.Static fields will not be tested. Superclass fields will be included.
Two randomly chosen, non-zero, odd numbers must be passed in. Ideally these should be different for each class, however this is not vital. Prime numbers are preferred, especially for the multiplier.
- Parameters:
initialNonZeroOddNumber- a non-zero, odd number used as the initial value. This will be the returned value if no fields are found to include in the hash codemultiplierNonZeroOddNumber- a non-zero, odd number used as the multiplierobject- the Object to create ahashCodefor- Returns:
- int hash code
- Throws:
java.lang.NullPointerException- Thrown if the Object isnull.java.lang.IllegalArgumentException- Thrown if the number is zero or even.- See Also:
HashCodeExclude
-
reflectionHashCode
public static int reflectionHashCode(int initialNonZeroOddNumber, int multiplierNonZeroOddNumber, java.lang.Object object, boolean testTransients)Uses reflection to build a valid hash code from the fields ofobject.It uses
AccessibleObject.setAccessibleto gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.If the TestTransients parameter is set to
true, transient members will be tested, otherwise they are ignored, as they are likely derived fields, and not part of the value of theObject.Static fields will not be tested. Superclass fields will be included.
Two randomly chosen, non-zero, odd numbers must be passed in. Ideally these should be different for each class, however this is not vital. Prime numbers are preferred, especially for the multiplier.
- Parameters:
initialNonZeroOddNumber- a non-zero, odd number used as the initial value. This will be the returned value if no fields are found to include in the hash codemultiplierNonZeroOddNumber- a non-zero, odd number used as the multiplierobject- the Object to create ahashCodefortestTransients- whether to include transient fields- Returns:
- int hash code
- Throws:
java.lang.NullPointerException- Thrown if the Object isnull.java.lang.IllegalArgumentException- Thrown if the number is zero or even.- See Also:
HashCodeExclude
-
reflectionHashCode
public static <T> int reflectionHashCode(int initialNonZeroOddNumber, int multiplierNonZeroOddNumber, T object, boolean testTransients, java.lang.Class<? super T> reflectUpToClass, java.lang.String... excludeFields)Uses reflection to build a valid hash code from the fields ofobject.It uses
AccessibleObject.setAccessibleto gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.If the TestTransients parameter is set to
true, transient members will be tested, otherwise they are ignored, as they are likely derived fields, and not part of the value of theObject.Static fields will not be included. Superclass fields will be included up to and including the specified superclass. A null superclass is treated as java.lang.Object.
Two randomly chosen, non-zero, odd numbers must be passed in. Ideally these should be different for each class, however this is not vital. Prime numbers are preferred, especially for the multiplier.
- Type Parameters:
T- the type of the object involved- Parameters:
initialNonZeroOddNumber- a non-zero, odd number used as the initial value. This will be the returned value if no fields are found to include in the hash codemultiplierNonZeroOddNumber- a non-zero, odd number used as the multiplierobject- the Object to create ahashCodefortestTransients- whether to include transient fieldsreflectUpToClass- the superclass to reflect up to (inclusive), may benullexcludeFields- array of field names to exclude from use in calculation of hash code- Returns:
- int hash code
- Throws:
java.lang.NullPointerException- Thrown if the Object isnull.java.lang.IllegalArgumentException- Thrown if the number is zero or even.- Since:
- 2.0
- See Also:
HashCodeExclude
-
reflectionHashCode
public static int reflectionHashCode(java.lang.Object object, boolean testTransients)Uses reflection to build a valid hash code from the fields ofobject.This constructor uses two hard coded choices for the constants needed to build a hash code.
It uses
AccessibleObject.setAccessibleto gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.If the TestTransients parameter is set to
true, transient members will be tested, otherwise they are ignored, as they are likely derived fields, and not part of the value of theObject.Static fields will not be tested. Superclass fields will be included. If no fields are found to include in the hash code, the result of this method will be constant.
- Parameters:
object- the Object to create ahashCodefortestTransients- whether to include transient fields- Returns:
- int hash code
- Throws:
java.lang.NullPointerException- Thrown if the object isnull.- See Also:
HashCodeExclude
-
reflectionHashCode
public static int reflectionHashCode(java.lang.Object object, java.util.Collection<java.lang.String> excludeFields)Uses reflection to build a valid hash code from the fields ofobject.This constructor uses two hard coded choices for the constants needed to build a hash code.
It uses
AccessibleObject.setAccessibleto gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.Transient members will be not be used, as they are likely derived fields, and not part of the value of the
Object.Static fields will not be tested. Superclass fields will be included. If no fields are found to include in the hash code, the result of this method will be constant.
- Parameters:
object- the Object to create ahashCodeforexcludeFields- Collection of String field names to exclude from use in calculation of hash code- Returns:
- int hash code
- Throws:
java.lang.NullPointerException- Thrown if the object isnull.- See Also:
HashCodeExclude
-
reflectionHashCode
public static int reflectionHashCode(java.lang.Object object, java.lang.String... excludeFields)Uses reflection to build a valid hash code from the fields ofobject.This constructor uses two hard coded choices for the constants needed to build a hash code.
It uses
AccessibleObject.setAccessibleto gain access to private fields. This means that it will throw a security exception if run under a security manager, if the permissions are not set up correctly. It is also not as efficient as testing explicitly.Transient members will be not be used, as they are likely derived fields, and not part of the value of the
Object.Static fields will not be tested. Superclass fields will be included. If no fields are found to include in the hash code, the result of this method will be constant.
- Parameters:
object- the Object to create ahashCodeforexcludeFields- array of field names to exclude from use in calculation of hash code- Returns:
- int hash code
- Throws:
java.lang.NullPointerException- Thrown if the object isnull.- See Also:
HashCodeExclude
-
append
public HashCodeBuilder append(boolean value)
Appends ahashCodefor aboolean.This adds
1when true, and0when false to thehashCode.This is in contrast to the standard
Boolean.hashCode()handling, which computes ahashCodevalue of1231forBooleaninstances that representtrueor1237forBooleaninstances that representfalse.This is in accordance with the Effective Java design.
- Parameters:
value- the boolean to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(boolean[] array)
Appends ahashCodefor abooleanarray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(byte value)
Appends ahashCodefor abyte.- Parameters:
value- the byte to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(byte[] array)
Appends ahashCodefor abytearray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(char value)
Appends ahashCodefor achar.- Parameters:
value- the char to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(char[] array)
Appends ahashCodefor achararray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(double value)
Appends ahashCodefor adouble.- Parameters:
value- the double to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(double[] array)
Appends ahashCodefor adoublearray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(float value)
Appends ahashCodefor afloat.- Parameters:
value- the float to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(float[] array)
Appends ahashCodefor afloatarray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(int value)
Appends ahashCodefor anint.- Parameters:
value- the int to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(int[] array)
Appends ahashCodefor anintarray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(long value)
Appends ahashCodefor along.- Parameters:
value- the long to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(long[] array)
Appends ahashCodefor alongarray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(java.lang.Object object)
Appends ahashCodefor anObject.- Parameters:
object- the Object to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(java.lang.Object[] array)
Appends ahashCodefor anObjectarray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(short value)
Appends ahashCodefor ashort.- Parameters:
value- the short to add to thehashCode- Returns:
thisinstance.
-
append
public HashCodeBuilder append(short[] array)
Appends ahashCodefor ashortarray.- Parameters:
array- the array to add to thehashCode- Returns:
thisinstance.
-
appendSuper
public HashCodeBuilder appendSuper(int superHashCode)
Adds the result of super.hashCode() to this builder.- Parameters:
superHashCode- the result of callingsuper.hashCode()- Returns:
thisinstance.- Since:
- 2.0
-
build
public java.lang.Integer build()
Returns the computedhashCode.
-
equals
public boolean equals(java.lang.Object obj)
Implements equals using the hash code.- Overrides:
equalsin classjava.lang.Object- Since:
- 3.13.0
-
hashCode
public int hashCode()
Returns the computedhashCodefromtoHashCode()due to the likelihood of bugs in mis-callingtoHashCode()and the unlikeliness of it mattering what the hashCode forHashCodeBuilderitself is.- Overrides:
hashCodein classjava.lang.Object- Returns:
hashCodebased on the fields appended- Since:
- 2.5
-
toHashCode
public int toHashCode()
Returns the computedhashCode.- Returns:
hashCodebased on the fields appended
-
-