org.aoju.bus.core.builder

Class EqualsBuilder

java.lang.Object

org.aoju.bus.core.builder.EqualsBuilder

All Implemented Interfaces:

Builder<Boolean>

public class EqualsBuilder
extends Object
implements Builder<Boolean>

Object.equals(Object) 方法的构建器 两个对象equals必须保证hashCode值相等 ,hashCode值相等不能保证一定相等

使用方法如下：

 public boolean equals(Object obj) {
   if (obj == null) { return false; }
   if (obj == this) { return true; }
   if (obj.getClass() != getClass()) {
     return false;
   }
   MyClass rhs = (MyClass) obj;
   return new EqualsBuilder()
                 .appendSuper(super.equals(obj))
                 .append(field1, rhs.field1)
                 .append(field2, rhs.field2)
                 .append(field3, rhs.field3)
                 .isEquals();
  }

 public boolean equals(Object obj) {
   return EqualsBuilder.reflectionEquals(this, obj);
 }
 

Since:

JDK 1.8+

Version:

5.5.0

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor and Description
EqualsBuilder()

Method Summary

Modifier and Type	Method and Description
EqualsBuilder	append(boolean[] lhs, boolean[] rhs)
EqualsBuilder	append(boolean lhs, boolean rhs)
EqualsBuilder	append(byte[] lhs, byte[] rhs)
EqualsBuilder	append(byte lhs, byte rhs)
EqualsBuilder	append(char[] lhs, char[] rhs)
EqualsBuilder	append(char lhs, char rhs)
EqualsBuilder	append(double[] lhs, double[] rhs)
EqualsBuilder	append(double lhs, double rhs)
EqualsBuilder	append(float[] lhs, float[] rhs)
EqualsBuilder	append(float lhs, float rhs)
EqualsBuilder	append(int[] lhs, int[] rhs)
EqualsBuilder	append(int lhs, int rhs)
EqualsBuilder	append(long[] lhs, long[] rhs)
EqualsBuilder	append(long lhs, long rhs)
EqualsBuilder	append(Object[] lhs, Object[] rhs)
EqualsBuilder	append(Object lhs, Object rhs)
EqualsBuilder	append(short[] lhs, short[] rhs)
EqualsBuilder	append(short lhs, short rhs)
EqualsBuilder	appendSuper(boolean superEquals)
Boolean	build() 构建
boolean	isEquals()
EqualsBuilder	reflectionAppend(Object lhs, Object rhs) 使用反射测试两个对象
static boolean	reflectionEquals(Object lhs, Object rhs, boolean testTransients) 此方法使用反射来确定两个对象是否相等
static boolean	reflectionEquals(Object lhs, Object rhs, boolean testTransients, Class<?> reflectUpToClass, boolean testRecursive, String... excludeFields) 此方法使用反射来确定两个对象是否相等
static boolean	reflectionEquals(Object lhs, Object rhs, boolean testTransients, Class<?> reflectUpToClass, String... excludeFields) 此方法使用反射来确定两个对象是否相等
static boolean	reflectionEquals(Object lhs, Object rhs, Collection<String> excludeFields) 反射检查两个对象是否equals,此方法检查对象及其父对象的属性（包括私有属性）是否相等
static boolean	reflectionEquals(Object lhs, Object rhs, String... excludeFields) 反射检查两个对象是否equals,此方法检查对象及其父对象的属性（包括私有属性）是否相等
void	reset()
EqualsBuilder	setBypassReflectionClasses(List<Class<?>> bypassReflectionClasses)
protected void	setEquals(boolean isEquals)
EqualsBuilder	setExcludeFields(String... excludeFields)
EqualsBuilder	setReflectUpToClass(Class<?> reflectUpToClass)
EqualsBuilder	setTestRecursive(boolean testRecursive) 置反射比较对象时是否测试忽略.
EqualsBuilder	setTestTransients(boolean testTransients) 设置反射比较对象时是否测试忽略.

Methods inherited from class java.lang.Object

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

Constructor Detail

EqualsBuilder

public EqualsBuilder()

Method Detail

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs,
                                       Collection<String> excludeFields)

反射检查两个对象是否equals,此方法检查对象及其父对象的属性（包括私有属性）是否相等

Parameters:

lhs - 此对象

rhs - 另一个对象

excludeFields - 排除的字段集合,如果有不参与计算equals的字段加入此集合即可

Returns:

两个对象是否equals, 是返回true

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs,
                                       String... excludeFields)

反射检查两个对象是否equals,此方法检查对象及其父对象的属性（包括私有属性）是否相等

Parameters:

lhs - 此对象

rhs - 另一个对象

excludeFields - 排除的字段集合,如果有不参与计算equals的字段加入此集合即可

Returns:

两个对象是否equals, 是返回true

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs,
                                       boolean testTransients)

此方法使用反射来确定两个对象是否相等

Parameters:

lhs - 对象

rhs - 其他对象

testTransients - 是否测试忽略

Returns:

true如果两个对象已测试相等.

See Also:

EqualsExclude

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs,
                                       boolean testTransients,
                                       Class<?> reflectUpToClass,
                                       String... excludeFields)

此方法使用反射来确定两个对象是否相等

Parameters:

lhs - 对象

rhs - 其他对象

testTransients - 是否测试忽略

reflectUpToClass - 要反映到(包括)的超类可以是null

excludeFields - 要从测试中排除的字段名的数组

Returns:

true如果两个对象已测试相等.

reflectionEquals

public static boolean reflectionEquals(Object lhs,
                                       Object rhs,
                                       boolean testTransients,
                                       Class<?> reflectUpToClass,
                                       boolean testRecursive,
                                       String... excludeFields)

此方法使用反射来确定两个对象是否相等

Parameters:

lhs - 对象

rhs - 其他对象

testTransients - 是否测试忽略

reflectUpToClass - 要反映到(包括)的超类可以是null

testRecursive - 是否递归地调用非基元字段上的反射等于.

excludeFields - 要从测试中排除的字段名的数组

Returns:

true如果两个对象已测试相等

setTestTransients

public EqualsBuilder setTestTransients(boolean testTransients)

设置反射比较对象时是否测试忽略.

Parameters:

testTransients - 是否测试忽略

Returns:

EqualsBuilder -调用链.

setTestRecursive

public EqualsBuilder setTestRecursive(boolean testRecursive)

置反射比较对象时是否测试忽略.

Parameters:

testRecursive - 是否做递归测试

Returns:

EqualsBuilder -调用链.

setBypassReflectionClasses

public EqualsBuilder setBypassReflectionClasses(List<Class<?>> bypassReflectionClasses)

setReflectUpToClass

public EqualsBuilder setReflectUpToClass(Class<?> reflectUpToClass)

setExcludeFields

public EqualsBuilder setExcludeFields(String... excludeFields)

reflectionAppend

public EqualsBuilder reflectionAppend(Object lhs,
                                      Object rhs)

使用反射测试两个对象

Parameters:

lhs - 左边对象

rhs - 右边对象

Returns:

EqualsBuilder -调用链.

appendSuper

public EqualsBuilder appendSuper(boolean superEquals)

append

public EqualsBuilder append(Object lhs,
                            Object rhs)

append

public EqualsBuilder append(long lhs,
                            long rhs)

append

public EqualsBuilder append(int lhs,
                            int rhs)

append

public EqualsBuilder append(short lhs,
                            short rhs)

append

public EqualsBuilder append(char lhs,
                            char rhs)

append

public EqualsBuilder append(byte lhs,
                            byte rhs)

append

public EqualsBuilder append(double lhs,
                            double rhs)

append

public EqualsBuilder append(float lhs,
                            float rhs)

append

public EqualsBuilder append(boolean lhs,
                            boolean rhs)

append

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

append

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

append

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

append

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

append

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

append

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

append

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

append

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

append

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

isEquals

public boolean isEquals()

setEquals

protected void setEquals(boolean isEquals)

build

public Boolean build()

Description copied from interface: Builder

构建

Specified by:

build in interface Builder<Boolean>

Returns:

被构建的对象

reset

public void reset()