cn.hutool.core.builder

类 CompareToBuilder

java.lang.Object

cn.hutool.core.builder.CompareToBuilder

所有已实现的接口:

Builder<Integer>, Serializable

public class CompareToBuilder
extends Object
implements Builder<Integer>

用于构建 Comparable.compareTo(Object) 方法的辅助工具

在Bean对象中，所有相关字段都参与比对，继承的字段不参与。使用方法如下：

 public class MyClass {
   String field1;
   int field2;
   boolean field3;

   ...

   public int compareTo(Object o) {
     MyClass myClass = (MyClass) o;
     return new CompareToBuilder()
       .appendSuper(super.compareTo(o)
       .append(this.field1, myClass.field1)
       .append(this.field2, myClass.field2)
       .append(this.field3, myClass.field3)
       .toComparison();
   }
 }
 

字段值按照顺序比较，如果某个字段返回非0结果，比较终止，使用toComparison()返回结果，后续比较忽略。

也可以使用reflectionCompare 方法通过反射比较字段，使用方法如下：

 public int compareTo(Object o) {
   return CompareToBuilder.reflectionCompare(this, o);
 }
 

TODO 待整理 来自于Apache-Commons-Lang3

从以下版本开始:

4.2.2

作者:

looly，Apache-Commons

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
CompareToBuilder() 构造，构造后调用append方法增加比较项，然后调用toComparison()获取结果

方法概要

方法

限定符和类型	方法和说明
CompareToBuilder	append(boolean[] lhs, boolean[] rhs) Appends to the builder the deep comparison of two boolean arrays.
CompareToBuilder	append(boolean lhs, boolean rhs) Appends to the builder the comparison of two booleanss.
CompareToBuilder	append(byte[] lhs, byte[] rhs) Appends to the builder the deep comparison of two byte arrays.
CompareToBuilder	append(byte lhs, byte rhs) Appends to the builder the comparison of two bytes.
CompareToBuilder	append(char[] lhs, char[] rhs) Appends to the builder the deep comparison of two char arrays.
CompareToBuilder	append(char lhs, char rhs) Appends to the builder the comparison of two chars.
CompareToBuilder	append(double[] lhs, double[] rhs) Appends to the builder the deep comparison of two double arrays.
CompareToBuilder	append(double lhs, double rhs) Appends to the builder the comparison of two doubles.
CompareToBuilder	append(float[] lhs, float[] rhs) Appends to the builder the deep comparison of two float arrays.
CompareToBuilder	append(float lhs, float rhs) Appends to the builder the comparison of two floats.
CompareToBuilder	append(int[] lhs, int[] rhs) Appends to the builder the deep comparison of two int arrays.
CompareToBuilder	append(int lhs, int rhs) Appends to the builder the comparison of two ints.
CompareToBuilder	append(long[] lhs, long[] rhs) Appends to the builder the deep comparison of two long arrays.
CompareToBuilder	append(long lhs, long rhs) Appends to the builder the comparison of two longs.
CompareToBuilder	append(Object[] lhs, Object[] rhs) Appends to the builder the deep comparison of two Object arrays.
CompareToBuilder	append(Object[] lhs, Object[] rhs, Comparator<?> comparator) Appends to the builder the deep comparison of two Object arrays.
CompareToBuilder	append(Object lhs, Object rhs) Appends to the builder the comparison of two Objects.
CompareToBuilder	append(Object lhs, Object rhs, Comparator<?> comparator) Appends to the builder the comparison of two Objects.
CompareToBuilder	append(short[] lhs, short[] rhs) Appends to the builder the deep comparison of two short arrays.
CompareToBuilder	append(short lhs, short rhs) Appends to the builder the comparison of two shorts.
CompareToBuilder	appendSuper(int superCompareTo) Appends to the builder the compareTo(Object) result of the superclass.
Integer	build() Returns a negative Integer, a positive Integer, or zero as the builder has judged the "left-hand" side as less than, greater than, or equal to the "right-hand" side.
static int	reflectionCompare(Object lhs, Object rhs) 通过反射比较两个Bean对象，对象字段可以为private。
static int	reflectionCompare(Object lhs, Object rhs, boolean compareTransients) Compares two Objects via reflection.
static int	reflectionCompare(Object lhs, Object rhs, boolean compareTransients, Class<?> reflectUpToClass, String... excludeFields) Compares two Objects via reflection.
static int	reflectionCompare(Object lhs, Object rhs, Collection<String> excludeFields) Compares two Objects via reflection.
static int	reflectionCompare(Object lhs, Object rhs, String... excludeFields) Compares two Objects via reflection.
int	toComparison() Returns a negative integer, a positive integer, or zero as the builder has judged the "left-hand" side as less than, greater than, or equal to the "right-hand" side.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CompareToBuilder

public CompareToBuilder()

构造，构造后调用append方法增加比较项，然后调用toComparison()获取结果

方法详细资料

reflectionCompare

public static int reflectionCompare(Object lhs,
                    Object rhs)

通过反射比较两个Bean对象，对象字段可以为private。比较规则如下：

• static字段不比较
• Transient字段不参与比较
• 父类字段参与比较

如果被比较的两个对象都为null，被认为相同。

参数:

lhs - 第一个对象

rhs - 第二个对象

返回:

a negative integer, zero, or a positive integer as lhs is less than, equal to, or greater than rhs

抛出:

NullPointerException - if either (but not both) parameters are null

ClassCastException - if rhs is not assignment-compatible with lhs

reflectionCompare

public static int reflectionCompare(Object lhs,
                    Object rhs,
                    boolean compareTransients)

Compares two Objects via reflection.

Fields can be private, thus AccessibleObject.setAccessible is used to bypass normal access control checks. This will fail under a security manager unless the appropriate permissions are set.

• Static fields will not be compared
• If compareTransients is true, compares transient members. Otherwise ignores them, as they are likely derived fields.
• Superclass fields will be compared

If both lhs and rhs are null, they are considered equal.

参数:

lhs - left-hand object

rhs - right-hand object

compareTransients - whether to compare transient fields

返回:

a negative integer, zero, or a positive integer as lhs is less than, equal to, or greater than rhs

抛出:

NullPointerException - if either lhs or rhs (but not both) is null

ClassCastException - if rhs is not assignment-compatible with lhs

reflectionCompare

public static int reflectionCompare(Object lhs,
                    Object rhs,
                    Collection<String> excludeFields)

Compares two Objects via reflection.

Fields can be private, thus AccessibleObject.setAccessible is used to bypass normal access control checks. This will fail under a security manager unless the appropriate permissions are set.

• Static fields will not be compared
• If compareTransients is true, compares transient members. Otherwise ignores them, as they are likely derived fields.
• Superclass fields will be compared

If both lhs and rhs are null, they are considered equal.

参数:

lhs - left-hand object

rhs - right-hand object

excludeFields - Collection of String fields to exclude

返回:

a negative integer, zero, or a positive integer as lhs is less than, equal to, or greater than rhs

抛出:

NullPointerException - if either lhs or rhs (but not both) is null

ClassCastException - if rhs is not assignment-compatible with lhs

从以下版本开始:

2.2

reflectionCompare

public static int reflectionCompare(Object lhs,
                    Object rhs,
                    String... excludeFields)

Compares two Objects via reflection.

Fields can be private, thus AccessibleObject.setAccessible is used to bypass normal access control checks. This will fail under a security manager unless the appropriate permissions are set.

• Static fields will not be compared
• If compareTransients is true, compares transient members. Otherwise ignores them, as they are likely derived fields.
• Superclass fields will be compared

If both lhs and rhs are null, they are considered equal.

参数:

lhs - left-hand object

rhs - right-hand object

excludeFields - array of fields to exclude

返回:

a negative integer, zero, or a positive integer as lhs is less than, equal to, or greater than rhs

抛出:

NullPointerException - if either lhs or rhs (but not both) is null

ClassCastException - if rhs is not assignment-compatible with lhs

从以下版本开始:

2.2

reflectionCompare

public static int reflectionCompare(Object lhs,
                    Object rhs,
                    boolean compareTransients,
                    Class<?> reflectUpToClass,
                    String... excludeFields)

Compares two Objects via reflection.

Fields can be private, thus AccessibleObject.setAccessible is used to bypass normal access control checks. This will fail under a security manager unless the appropriate permissions are set.

• Static fields will not be compared
• If the compareTransients is true, compares transient members. Otherwise ignores them, as they are likely derived fields.
• Compares superclass fields up to and including reflectUpToClass. If reflectUpToClass is null, compares all superclass fields.

If both lhs and rhs are null, they are considered equal.

参数:

lhs - left-hand object

rhs - right-hand object

compareTransients - whether to compare transient fields

reflectUpToClass - last superclass for which fields are compared

excludeFields - fields to exclude

返回:

a negative integer, zero, or a positive integer as lhs is less than, equal to, or greater than rhs

抛出:

NullPointerException - if either lhs or rhs (but not both) is null

ClassCastException - if rhs is not assignment-compatible with lhs

从以下版本开始:

2.2 (2.0 as reflectionCompare(Object, Object, boolean, Class))

appendSuper

public CompareToBuilder appendSuper(int superCompareTo)

Appends to the builder the compareTo(Object) result of the superclass.

参数:

superCompareTo - result of calling super.compareTo(Object)

返回:

this - used to chain append calls

从以下版本开始:

2.0

append

public CompareToBuilder append(Object lhs,
                      Object rhs)

Appends to the builder the comparison of two Objects.

1. Check if lhs == rhs
2. Check if either lhs or rhs is null, a null object is less than a non-null object
3. Check the object contents

lhs must either be an array or implement Comparable.

参数:

lhs - left-hand object

rhs - right-hand object

返回:

this - used to chain append calls

抛出:

ClassCastException - if rhs is not assignment-compatible with lhs

append

public CompareToBuilder append(Object lhs,
                      Object rhs,
                      Comparator<?> comparator)

Appends to the builder the comparison of two Objects.

1. Check if lhs == rhs
2. Check if either lhs or rhs is null, a null object is less than a non-null object
3. Check the object contents

If lhs is an array, array comparison methods will be used. Otherwise comparator will be used to compare the objects. If comparator is null, lhs must implement Comparable instead.

参数:

lhs - left-hand object

rhs - right-hand object

comparator - Comparator used to compare the objects, null means treat lhs as Comparable

返回:

this - used to chain append calls

抛出:

ClassCastException - if rhs is not assignment-compatible with lhs

从以下版本开始:

2.0

append

public CompareToBuilder append(long lhs,
                      long rhs)

Appends to the builder the comparison of two longs.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(int lhs,
                      int rhs)

Appends to the builder the comparison of two ints.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(short lhs,
                      short rhs)

Appends to the builder the comparison of two shorts.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(char lhs,
                      char rhs)

Appends to the builder the comparison of two chars.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(byte lhs,
                      byte rhs)

Appends to the builder the comparison of two bytes.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(double lhs,
                      double rhs)

Appends to the builder the comparison of two doubles.

This handles NaNs, Infinities, and -0.0.

It is compatible with the hash code generated by HashCodeBuilder.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(float lhs,
                      float rhs)

Appends to the builder the comparison of two floats.

This handles NaNs, Infinities, and -0.0.

It is compatible with the hash code generated by HashCodeBuilder.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(boolean lhs,
                      boolean rhs)

Appends to the builder the comparison of two booleanss.

参数:

lhs - left-hand value

rhs - right-hand value

返回:

this - used to chain append calls

append

public CompareToBuilder append(Object[] lhs,
                      Object[] rhs)

Appends to the builder the deep comparison of two Object arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a short length array is less than a long length array
4. 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.

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

抛出:

ClassCastException - if rhs is not assignment-compatible with lhs

append

public CompareToBuilder append(Object[] lhs,
                      Object[] rhs,
                      Comparator<?> comparator)

Appends to the builder the deep comparison of two Object arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a short length array is less than a long length array
4. 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.

参数:

lhs - left-hand array

rhs - right-hand array

comparator - Comparator to use to compare the array elements, null means to treat lhs elements as Comparable.

返回:

this - used to chain append calls

抛出:

ClassCastException - if rhs is not assignment-compatible with lhs

从以下版本开始:

2.0

append

public CompareToBuilder append(long[] lhs,
                      long[] rhs)

Appends to the builder the deep comparison of two long arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(long, long)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(int[] lhs,
                      int[] rhs)

Appends to the builder the deep comparison of two int arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(int, int)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(short[] lhs,
                      short[] rhs)

Appends to the builder the deep comparison of two short arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(short, short)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(char[] lhs,
                      char[] rhs)

Appends to the builder the deep comparison of two char arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(char, char)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(byte[] lhs,
                      byte[] rhs)

Appends to the builder the deep comparison of two byte arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(byte, byte)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(double[] lhs,
                      double[] rhs)

Appends to the builder the deep comparison of two double arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(double, double)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(float[] lhs,
                      float[] rhs)

Appends to the builder the deep comparison of two float arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(float, float)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

append

public CompareToBuilder append(boolean[] lhs,
                      boolean[] rhs)

Appends to the builder the deep comparison of two boolean arrays.

1. Check if arrays are the same using ==
2. Check if for null, null is less than non-null
3. Check array length, a shorter length array is less than a longer length array
4. Check array contents element by element using append(boolean, boolean)

参数:

lhs - left-hand array

rhs - right-hand array

返回:

this - used to chain append calls

toComparison

public int toComparison()

Returns a negative integer, a positive integer, or zero as the builder has judged the "left-hand" side as less than, greater than, or equal to the "right-hand" side.

返回:

final comparison result

另请参阅:

build()

build

public Integer build()

Returns a negative Integer, a positive Integer, or zero as the builder has judged the "left-hand" side as less than, greater than, or equal to the "right-hand" side.

指定者:

build 在接口中 Builder<Integer>

返回:

final comparison result as an Integer

从以下版本开始:

3.0

另请参阅:

toComparison()