Package org.apache.commons.lang3.builder

Provides classes to create 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 hash code.

Since:

1.0

See Also:

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

Interface Summary

Interface	Description
Builder<T>	The Builder interface is designed to designate a class as a builder object in the Builder design pattern.
Diffable<T>	Diffable classes can be compared with other objects for differences.
DiffBuilder.SerializableSupplier<T>	Private interface while we still have to support serialization.

Class Summary

Class	Description
AbstractSupplier<T,B extends AbstractSupplier<T,B,E>,E extends java.lang.Throwable>	Abstracts supplying an instance of T.
CompareToBuilder	Assists in implementing Comparable.compareTo(Object) methods.
Diff<T>	A Diff contains the differences between two Diffable class fields.
DiffBuilder<T>	Assists in implementing Diffable.diff(Object) methods.
DiffBuilder.Builder<T>	Constructs a new instance.
DiffBuilder.SDiff<T>
DiffResult<T>	A DiffResult contains a collection of the differences between two Diffable objects.
EqualsBuilder	Assists in implementing Object.equals(Object) methods.
HashCodeBuilder	Assists in implementing Object.hashCode() methods.
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.
Reflection	Package-private reflection code.
ReflectionDiffBuilder<T>	Assists in implementing Diffable.diff(Object) methods.
ReflectionDiffBuilder.Builder<T>	Constructs a new instance.
ReflectionToStringBuilder	Assists in implementing Object.toString() methods using reflection.
StandardToStringStyle	Works with ToStringBuilder to create a toString.
ToStringBuilder	Assists in implementing Object.toString() methods.
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 class name 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 hash code.
ToStringStyle.SimpleToStringStyle	ToStringStyle that does not print out the class name, identity hash code, content start or field name.

Annotation Types Summary

Annotation Type	Description
DiffExclude	Excludes a field from being used by the ReflectionDiffBuilder.
EqualsExclude	Excludes a field from being used by the various reflectionEquals methods defined on EqualsBuilder.
HashCodeExclude	Exclude a field from being used by the various reflectionHashcode methods defined on HashCodeBuilder.
ToStringExclude	Excludes a field from being used by the ReflectionToStringBuilder.
ToStringSummary	Use this annotation on the fields to get the summary instead of the detailed information when using ReflectionToStringBuilder.