Package org.apache.commons.lang3.builder

package org.apache.commons.lang3.builder

Assists in creating consistent equals(Object), toString(), hashCode(), and compareTo(Object) methods. These classes are not thread-safe.

When you write a hashCode(), do you check Bloch's Effective Java? No? You just hack in a quick number? Well HashCodeBuilder will save your day. It, and its buddies (EqualsBuilder, CompareToBuilder, ToStringBuilder), take care of the nasty bits while you focus on the important bits, like which fields will go into making up the hashcode.

Since:

1.0

See Also:

• Object.equals(Object)
• Object.toString()
• Object.hashCode()
• Comparable.compareTo(Object)

Related Packages

Package	Description
org.apache.commons.lang3	Provides highly reusable static utility methods, chiefly concerned with adding value to the java.lang classes.

Class	Description
Builder<T>	The Builder interface is designed to designate a class as a builder object in the Builder design pattern.
CompareToBuilder	Assists in implementing Comparable.compareTo(Object) methods.
Diff<T>	A Diff contains the differences between two Diffable class fields.
Diffable<T>	Diffable classes can be compared with other objects for differences.
DiffBuilder<T>	Assists in implementing Diffable.diff(Object) methods.
DiffResult<T>	A DiffResult contains a collection of the differences between two Diffable objects.
EqualsBuilder	Assists in implementing Object.equals(Object) methods.
EqualsExclude	Use this annotation to exclude a field from being used by the various reflectionEquals methods defined on EqualsBuilder.
HashCodeBuilder	Assists in implementing Object.hashCode() methods.
HashCodeExclude	Use this annotation to exclude a field from being used by the various reflectionHashcode methods defined on HashCodeBuilder.
IDKey	Wrap an identity key (System.identityHashCode()) so that an object can only be equal() to itself.
MultilineRecursiveToStringStyle	Works with ToStringBuilder to create a "deep" toString.
RecursiveToStringStyle	Works with ToStringBuilder to create a "deep" toString.
ReflectionDiffBuilder<T>	Assists in implementing Diffable.diff(Object) methods.
ReflectionToStringBuilder	Assists in implementing Object.toString() methods using reflection.
StandardToStringStyle	Works with ToStringBuilder to create a toString.
ToStringBuilder	Assists in implementing Object.toString() methods.
ToStringExclude	Use this annotation to exclude a field from being used by the ReflectionToStringBuilder.
ToStringStyle	Controls String formatting for ToStringBuilder.
ToStringStyle.DefaultToStringStyle	Default ToStringStyle.
ToStringStyle.JsonToStringStyle	ToStringStyle that outputs with JSON format.
ToStringStyle.MultiLineToStringStyle	ToStringStyle that outputs on multiple lines.
ToStringStyle.NoClassNameToStringStyle	ToStringStyle that does not print out the classname and identity hash code but prints content start and field names.
ToStringStyle.NoFieldNameToStringStyle	ToStringStyle that does not print out the field names.
ToStringStyle.ShortPrefixToStringStyle	ToStringStyle that prints out the short class name and no identity hashcode.
ToStringStyle.SimpleToStringStyle	ToStringStyle that does not print out the classname, identity hashcode, content start or field name.
ToStringSummary	Use this annotation on the fields to get the summary instead of the detailed information when using ReflectionToStringBuilder.