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 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. -
Class Summary Class Description CompareToBuilder Assists in implementingComparable.compareTo(Object)
methods.Diff<T> DiffBuilder<T> Assists in implementingDiffable.diff(Object)
methods.DiffResult<T> ADiffResult
contains a collection of the differences between twoDiffable
objects.EqualsBuilder Assists in implementingObject.equals(Object)
methods.HashCodeBuilder Assists in implementingObject.hashCode()
methods.MultilineRecursiveToStringStyle Works withToStringBuilder
to create a "deep"toString
.RecursiveToStringStyle Works withToStringBuilder
to create a "deep"toString
.ReflectionDiffBuilder<T> Assists in implementingDiffable.diff(Object)
methods.ReflectionToStringBuilder Assists in implementingObject.toString()
methods using reflection.StandardToStringStyle Works withToStringBuilder
to create atoString
.ToStringBuilder Assists in implementingObject.toString()
methods.ToStringStyle ControlsString
formatting forToStringBuilder
. -
Annotation Types Summary Annotation Type Description DiffExclude Excludes a field from being used by theReflectionDiffBuilder
.EqualsExclude Excludes a field from being used by the variousreflectionEquals
methods defined onEqualsBuilder
.HashCodeExclude Exclude a field from being used by the variousreflectionHashcode
methods defined onHashCodeBuilder
.ToStringExclude Excludes a field from being used by theReflectionToStringBuilder
.ToStringSummary Use this annotation on the fields to get the summary instead of the detailed information when usingReflectionToStringBuilder
.