DiffBuilder (bus-all 5.3.5 API)

java.lang.Object
- org.aoju.bus.core.builder.DiffBuilder

All Implemented Interfaces:: Builder<DiffResult>

public class DiffBuilder
extends Object
implements Builder<DiffResult>

协助实现Diffable.diff(Object)方法

 public class Person implements Diffable<Person> {
   String name;
   int age;
   boolean smoker;

   ...

   public DiffResult diff(Person obj) {
     // No need for null check, as NullPointerException correct if obj is null
     return new DiffBuilder(this, obj, ToStringStyle.SHORT_PREFIX_STYLE)
       .append("name", this.name, obj.name)
       .append("age", this.age, obj.age)
       .append("smoker", this.smoker, obj.smoker)
       .build();
   }
 }

传递给构造函数的ToStringStyle嵌入到返回的DiffResult中，并影响DiffResult. tostring()方法的风格。可以通过调用 DiffResult.toString(ToStringStyle)覆盖此样式选择。.

Since:: JDK 1.8+
Version:: 5.3.5
Author:: Kimi Liu
See Also:: Diffable, Diff, DiffResult, ToStringStyle

Constructor Summary

Constructors
Constructor and Description
`DiffBuilder(Object lhs, Object rhs, ToStringStyle style)` 使用指定样式为指定对象构造一个生成器
`DiffBuilder(Object lhs, Object rhs, ToStringStyle style, boolean testTriviallyEqual)` 使用指定样式为指定对象构造一个生成器如果`lhs == rhs`或`lhs.equals(rhs)`，则构建器将不计算对`append(…)`的任何调用，并在`build()`执行时返回一个空的`DiffResult`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DiffBuilder`	`append(String fieldName, boolean[] lhs, boolean[] rhs)` 测试两个`boolean[]`是否相等
`DiffBuilder`	`append(String fieldName, boolean lhs, boolean rhs)` 测试两个`boolean`是否相等
`DiffBuilder`	`append(String fieldName, byte[] lhs, byte[] rhs)` 测试两个`byte[]`是否相等
`DiffBuilder`	`append(String fieldName, byte lhs, byte rhs)` 测试两个`byte`是否相等
`DiffBuilder`	`append(String fieldName, char[] lhs, char[] rhs)` 测试两个`char[]`是否相等
`DiffBuilder`	`append(String fieldName, char lhs, char rhs)` 测试两个`char`是否相等
`DiffBuilder`	`append(String fieldName, DiffResult diffResult)` 附加来自另一个`DiffResult`的差异.
`DiffBuilder`	`append(String fieldName, double[] lhs, double[] rhs)` 测试两个 `double[]`是否相等
`DiffBuilder`	`append(String fieldName, double lhs, double rhs)` 测试两个`char[]`是否相等
`DiffBuilder`	`append(String fieldName, float[] lhs, float[] rhs)` 测试两个 `float[]`是否相等
`DiffBuilder`	`append(String fieldName, float lhs, float rhs)` 测试两个 `float`是否相等
`DiffBuilder`	`append(String fieldName, int[] lhs, int[] rhs)` 测试两个 `int[]`是否相等
`DiffBuilder`	`append(String fieldName, int lhs, int rhs)` 测试两个 `int`是否相等
`DiffBuilder`	`append(String fieldName, long[] lhs, long[] rhs)` 测试两个 `long[]`是否相等
`DiffBuilder`	`append(String fieldName, long lhs, long rhs)` 测试两个 `long`是否相等
`DiffBuilder`	`append(String fieldName, Object[] lhs, Object[] rhs)` 测试两个 `Object[]`是否相等
`DiffBuilder`	`append(String fieldName, Object lhs, Object rhs)` 测试两个 `Objects`是否相等
`DiffBuilder`	`append(String fieldName, short[] lhs, short[] rhs)` 测试两个 `short[]`是否相等
`DiffBuilder`	`append(String fieldName, short lhs, short rhs)` 测试两个 `short`是否相等
`DiffResult`	`build()` 构建

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DiffBuilder
```
public DiffBuilder(Object lhs,
                   Object rhs,
                   ToStringStyle style,
                   boolean testTriviallyEqual)
```
    使用指定样式为指定对象构造一个生成器如果lhs == rhs或lhs.equals(rhs)，则构建器将不计算对append(…)的任何调用，并在build()执行时返回一个空的DiffResult.
    
    Parameters:
    
    lhs - this 对象
    
    rhs - 反对的对象
    
    style - 当输出对象时将使用该样式，null使用默认值
    
    testTriviallyEqual - 如果为真，这将测试lhs和rhs是否相同或相等。如果启用了简单的相等测试并返回true，那么所有的append(fieldName、lhs、rhs)方法都将中止，而不创建字段Diff 这个测试的结果在DiffBuilder的整个生命周期内都不会改变。.
  - DiffBuilder
```
public DiffBuilder(Object lhs,
                   Object rhs,
                   ToStringStyle style)
```
    使用指定样式为指定对象构造一个生成器
    
    Parameters:
    
    lhs - this 对象
    
    rhs - 反对的对象
    
    style - 当输出对象时将使用该样式，null使用默认值
- Method Detail
  - append
```
public DiffBuilder append(String fieldName,
                          boolean lhs,
                          boolean rhs)
```
    测试两个boolean是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 boolean
    
    rhs - 右边 boolean
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          boolean[] lhs,
                          boolean[] rhs)
```
    测试两个boolean[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 boolean[]
    
    rhs - 右边 boolean[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          byte lhs,
                          byte rhs)
```
    测试两个byte是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 byte
    
    rhs - 右边 byte
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          byte[] lhs,
                          byte[] rhs)
```
    测试两个byte[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 byte[]
    
    rhs - 右边 byte[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          char lhs,
                          char rhs)
```
    测试两个char是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 char
    
    rhs - 右边 char
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          char[] lhs,
                          char[] rhs)
```
    测试两个char[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 char[]
    
    rhs - 右边 char[]
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if field name is null
  - append
```
public DiffBuilder append(String fieldName,
                          double lhs,
                          double rhs)
```
    测试两个char[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 double
    
    rhs - 右边 double
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          double[] lhs,
                          double[] rhs)
```
    测试两个 double[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 double[]
    
    rhs - 右边 double[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          float lhs,
                          float rhs)
```
    测试两个 float是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 float
    
    rhs - 右边 float
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          float[] lhs,
                          float[] rhs)
```
    测试两个 float[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 float[]
    
    rhs - 右边 float[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          int lhs,
                          int rhs)
```
    测试两个 int是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 int
    
    rhs - 右边 int
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          int[] lhs,
                          int[] rhs)
```
    测试两个 int[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 int[]
    
    rhs - 右边 int[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          long lhs,
                          long rhs)
```
    测试两个 long是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 long
    
    rhs - 右边 long
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          long[] lhs,
                          long[] rhs)
```
    测试两个 long[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 long[]
    
    rhs - 右边 long[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          short lhs,
                          short rhs)
```
    测试两个 short是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 short
    
    rhs - 右边 short
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          short[] lhs,
                          short[] rhs)
```
    测试两个 short[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 short[]
    
    rhs - 右边 short[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          Object lhs,
                          Object rhs)
```
    测试两个 Objects是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 Object
    
    rhs - 右边 Object
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if field name is null
  - append
```
public DiffBuilder append(String fieldName,
                          Object[] lhs,
                          Object[] rhs)
```
    测试两个 Object[]是否相等
    
    Parameters:
    
    fieldName - 字段名
    
    lhs - 左边 Object[]
    
    rhs - 右边 Object[]
    
    Returns:
    
    this
  - append
```
public DiffBuilder append(String fieldName,
                          DiffResult diffResult)
```
    附加来自另一个DiffResult的差异. 如果您想要比较本身是可扩散的属性，并且想要知道它的哪一部分是不同的，那么这个方法是很有用的.
```
 public class Person implements Diffable<Person> {
   String name;
   Address address; // implements Diffable<Address>

   ...

   public DiffResult diff(Person obj) {
     return new DiffBuilder(this, obj, ToStringStyle.SHORT_PREFIX_STYLE)
       .append("name", this.name, obj.name)
       .append("address", this.address.diff(obj.address))
       .build();
   }
 }
 
```
    Parameters:
    
    fieldName - 字段名
    
    diffResult - 要附加的DiffResult
    
    Returns:
    
    this
    
    Since:
    
    3.5.0
  - build
```
public DiffResult build()
```
    Description copied from interface: Builder
    
    构建
    
    Specified by:
    
    build in interface Builder<DiffResult>
    
    Returns:
    
    被构建的对象

Class DiffBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DiffBuilder

DiffBuilder

Method Detail

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

build