Class CompareToBuilder
Comparable.compareTo(Object) methods.
This code is based on CompareToBuilder from commons-lang v2.6- Since:
- 4.1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionappend(boolean[] lhs, boolean[] rhs) Appends to thebuilderthe deep comparison of twobooleanarrays.append(boolean lhs, boolean rhs) Appends to thebuilderthe comparison of twobooleanss.append(byte[] lhs, byte[] rhs) Appends to thebuilderthe deep comparison of twobytearrays.append(byte lhs, byte rhs) Appends to thebuilderthe comparison of twobytes.append(char[] lhs, char[] rhs) Appends to thebuilderthe deep comparison of twochararrays.append(char lhs, char rhs) Appends to thebuilderthe comparison of twochars.append(double[] lhs, double[] rhs) Appends to thebuilderthe deep comparison of twodoublearrays.append(double lhs, double rhs) Appends to thebuilderthe comparison of twodoubles.append(float[] lhs, float[] rhs) Appends to thebuilderthe deep comparison of twofloatarrays.append(float lhs, float rhs) Appends to thebuilderthe comparison of twofloats.append(int[] lhs, int[] rhs) Appends to thebuilderthe deep comparison of twointarrays.append(int lhs, int rhs) Appends to thebuilderthe comparison of twoints.append(long[] lhs, long[] rhs) Appends to thebuilderthe deep comparison of twolongarrays.append(long lhs, long rhs) Appends to thebuilderthe comparison of twolongs.append(short[] lhs, short[] rhs) Appends to thebuilderthe deep comparison of twoshortarrays.append(short lhs, short rhs) Appends to thebuilderthe comparison of twoshorts.Appends to thebuilderthe deep comparison of twoObjectarrays.append(Object[] lhs, Object[] rhs, Comparator comparator) Appends to thebuilderthe deep comparison of twoObjectarrays.Appends to thebuilderthe comparison of twoObjects.append(Object lhs, Object rhs, Comparator comparator) Appends to thebuilderthe comparison of twoObjects.appendSuper(int superCompareTo) Appends to thebuilderthecompareTo(Object)result of the superclass.intReturns a negative integer, a positive integer, or zero as thebuilderhas judged the "left-hand" side as less than, greater than, or equal to the "right-hand" side.
-
Constructor Details
-
CompareToBuilder
public CompareToBuilder()Constructor for CompareToBuilder.
Starts off assuming that the objects are equal. Multiple calls are then made to the various append methods, followed by a call to
toComparison()to get the result.
-
-
Method Details
-
appendSuper
Appends to the
builderthecompareTo(Object)result of the superclass.- Parameters:
superCompareTo- result of callingsuper.compareTo(Object)- Returns:
- this - used to chain append calls
-
append
Appends to the
builderthe comparison of twoObjects.- Check if
lhs == rhs - Check if either
lhsorrhsisnull, anullobject is less than a non-nullobject - Check the object contents
lhsmust either be an array or implementComparable.- Parameters:
lhs- left-hand objectrhs- right-hand object- Returns:
- this - used to chain append calls
- Throws:
ClassCastException- ifrhsis not assignment-compatible withlhs
- Check if
-
append
Appends to the
builderthe comparison of twoObjects.- Check if
lhs == rhs - Check if either
lhsorrhsisnull, anullobject is less than a non-nullobject - Check the object contents
If
lhsis an array, array comparison methods will be used. Otherwisecomparatorwill be used to compare the objects. Ifcomparatorisnull,lhsmust implementComparableinstead.- Parameters:
lhs- left-hand objectrhs- right-hand objectcomparator-Comparatorused to compare the objects,nullmeans treat lhs asComparable- Returns:
- this - used to chain append calls
- Throws:
ClassCastException- ifrhsis not assignment-compatible withlhs- Since:
- 2.0
- Check if
-
append
Appends to thebuilderthe comparison of twolongs.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to thebuilderthe comparison of twoints.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to thebuilderthe comparison of twoshorts.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to thebuilderthe comparison of twochars.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to thebuilderthe comparison of twobytes.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to the
builderthe comparison of twodoubles.This handles NaNs, Infinities, and
-0.0.It is compatible with the hash code generated by
HashCodeBuilder.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to the
builderthe comparison of twofloats.This handles NaNs, Infinities, and
-0.0.It is compatible with the hash code generated by
HashCodeBuilder.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to thebuilderthe comparison of twobooleanss.- Parameters:
lhs- left-hand valuerhs- right-hand value- Returns:
- this - used to chain append calls
-
append
Appends to the
builderthe deep comparison of twoObjectarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a short length array is less than a long length array
- Check array contents element by element using
append(Object, Object, Comparator)
This method will also will be called for the top level of multi-dimensional, ragged, and multi-typed arrays.
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Throws:
ClassCastException- ifrhsis not assignment-compatible withlhs
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twoObjectarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a short length array is less than a long length array
- Check array contents element by element using
append(Object, Object, Comparator)
This method will also will be called for the top level of multi-dimensional, ragged, and multi-typed arrays.
- Parameters:
lhs- left-hand arrayrhs- right-hand arraycomparator-Comparatorto use to compare the array elements,nullmeans to treatlhselements asComparable.- Returns:
- this - used to chain append calls
- Throws:
ClassCastException- ifrhsis not assignment-compatible withlhs- Since:
- 2.0
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twolongarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(long, long)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twointarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(int, int)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twoshortarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(short, short)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twochararrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(char, char)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twobytearrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(byte, byte)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twodoublearrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(double, double)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twofloatarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(float, float)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
append
Appends to the
builderthe deep comparison of twobooleanarrays.- Check if arrays are the same using
== - Check if for
null,nullis less than non-null - Check array length, a shorter length array is less than a longer length array
- Check array contents element by element using
append(boolean, boolean)
- Parameters:
lhs- left-hand arrayrhs- right-hand array- Returns:
- this - used to chain append calls
- Check if arrays are the same using
-
toComparison
public int toComparison()Returns a negative integer, a positive integer, or zero as thebuilderhas judged the "left-hand" side as less than, greater than, or equal to the "right-hand" side.- Returns:
- final comparison result
-