public class DiffBuilder extends Object implements Builder<DiffResult>
Assists in implementing Diffable.diff(Object) methods.
To use this class, write code as follows:
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();
}
}
The ToStringStyle passed to the constructor is embedded in the
returned DiffResult and influences the style of the
DiffResult.toString() method. This style choice can be overridden by
calling DiffResult.toString(ToStringStyle).
Diffable,
Diff,
DiffResult,
ToStringStyle| Constructor and Description |
|---|
DiffBuilder(Object lhs,
Object rhs,
ToStringStyle style)
Constructs a builder for the specified objects with the specified style.
|
DiffBuilder(Object lhs,
Object rhs,
ToStringStyle style,
boolean testTriviallyEqual)
Constructs a builder for the specified objects with the specified style.
|
| Modifier and Type | Method and Description |
|---|---|
DiffBuilder |
append(String fieldName,
boolean[] lhs,
boolean[] rhs)
Test if two
boolean[]s are equal. |
DiffBuilder |
append(String fieldName,
boolean lhs,
boolean rhs)
Test if two
booleans are equal. |
DiffBuilder |
append(String fieldName,
byte[] lhs,
byte[] rhs)
Test if two
byte[]s are equal. |
DiffBuilder |
append(String fieldName,
byte lhs,
byte rhs)
Test if two
bytes are equal. |
DiffBuilder |
append(String fieldName,
char[] lhs,
char[] rhs)
Test if two
char[]s are equal. |
DiffBuilder |
append(String fieldName,
char lhs,
char rhs)
Test if two
chars are equal. |
DiffBuilder |
append(String fieldName,
DiffResult diffResult)
Append diffs from another
DiffResult. |
DiffBuilder |
append(String fieldName,
double[] lhs,
double[] rhs)
Test if two
double[]s are equal. |
DiffBuilder |
append(String fieldName,
double lhs,
double rhs)
Test if two
doubles are equal. |
DiffBuilder |
append(String fieldName,
float[] lhs,
float[] rhs)
Test if two
float[]s are equal. |
DiffBuilder |
append(String fieldName,
float lhs,
float rhs)
Test if two
floats are equal. |
DiffBuilder |
append(String fieldName,
int[] lhs,
int[] rhs)
Test if two
int[]s are equal. |
DiffBuilder |
append(String fieldName,
int lhs,
int rhs)
Test if two
ints are equal. |
DiffBuilder |
append(String fieldName,
long[] lhs,
long[] rhs)
Test if two
long[]s are equal. |
DiffBuilder |
append(String fieldName,
long lhs,
long rhs)
Test if two
longs are equal. |
DiffBuilder |
append(String fieldName,
Object[] lhs,
Object[] rhs)
Test if two
Object[]s are equal. |
DiffBuilder |
append(String fieldName,
Object lhs,
Object rhs)
Test if two
Objectss are equal. |
DiffBuilder |
append(String fieldName,
short[] lhs,
short[] rhs)
Test if two
short[]s are equal. |
DiffBuilder |
append(String fieldName,
short lhs,
short rhs)
Test if two
shorts are equal. |
DiffResult |
build()
Builds a
DiffResult based on the differences appended to this
builder. |
public DiffBuilder(Object lhs, Object rhs, ToStringStyle style, boolean testTriviallyEqual)
Constructs a builder for the specified objects with the specified style.
If lhs == rhs or lhs.equals(rhs) then the builder will
not evaluate any calls to append(...) and will return an empty
DiffResult when build() is executed.
lhs - this objectrhs - the object to diff againststyle - the style will use when outputting the objects, null
uses the defaulttestTriviallyEqual - If true, this will test if lhs and rhs are the same or equal.
All of the append(fieldName, lhs, rhs) methods will abort
without creating a field Diff if the trivially equal
test is enabled and returns true. The result of this test
is never changed throughout the life of this DiffBuilder.IllegalArgumentException - if lhs or rhs is nullpublic DiffBuilder(Object lhs, Object rhs, ToStringStyle style)
Constructs a builder for the specified objects with the specified style.
If lhs == rhs or lhs.equals(rhs) then the builder will
not evaluate any calls to append(...) and will return an empty
DiffResult when build() is executed.
This delegates to DiffBuilder(Object, Object, ToStringStyle, boolean)
with the testTriviallyEqual flag enabled.
lhs - this objectrhs - the object to diff againststyle - the style will use when outputting the objects, null
uses the defaultIllegalArgumentException - if lhs or rhs is nullpublic DiffBuilder append(String fieldName, boolean lhs, boolean rhs)
Test if two booleans are equal.
fieldName - the field namelhs - the left hand booleanrhs - the right hand booleanIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, boolean[] lhs, boolean[] rhs)
Test if two boolean[]s are equal.
fieldName - the field namelhs - the left hand boolean[]rhs - the right hand boolean[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, byte lhs, byte rhs)
Test if two bytes are equal.
fieldName - the field namelhs - the left hand byterhs - the right hand byteIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, byte[] lhs, byte[] rhs)
Test if two byte[]s are equal.
fieldName - the field namelhs - the left hand byte[]rhs - the right hand byte[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, char lhs, char rhs)
Test if two chars are equal.
fieldName - the field namelhs - the left hand charrhs - the right hand charIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, char[] lhs, char[] rhs)
Test if two char[]s are equal.
fieldName - the field namelhs - the left hand char[]rhs - the right hand char[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, double lhs, double rhs)
Test if two doubles are equal.
fieldName - the field namelhs - the left hand doublerhs - the right hand doubleIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, double[] lhs, double[] rhs)
Test if two double[]s are equal.
fieldName - the field namelhs - the left hand double[]rhs - the right hand double[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, float lhs, float rhs)
Test if two floats are equal.
fieldName - the field namelhs - the left hand floatrhs - the right hand floatIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, float[] lhs, float[] rhs)
Test if two float[]s are equal.
fieldName - the field namelhs - the left hand float[]rhs - the right hand float[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, int lhs, int rhs)
Test if two ints are equal.
fieldName - the field namelhs - the left hand intrhs - the right hand intIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, int[] lhs, int[] rhs)
Test if two int[]s are equal.
fieldName - the field namelhs - the left hand int[]rhs - the right hand int[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, long lhs, long rhs)
Test if two longs are equal.
fieldName - the field namelhs - the left hand longrhs - the right hand longIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, long[] lhs, long[] rhs)
Test if two long[]s are equal.
fieldName - the field namelhs - the left hand long[]rhs - the right hand long[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, short lhs, short rhs)
Test if two shorts are equal.
fieldName - the field namelhs - the left hand shortrhs - the right hand shortIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, short[] lhs, short[] rhs)
Test if two short[]s are equal.
fieldName - the field namelhs - the left hand short[]rhs - the right hand short[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, Object lhs, Object rhs)
Test if two Objectss are equal.
fieldName - the field namelhs - the left hand Objectrhs - the right hand ObjectIllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, Object[] lhs, Object[] rhs)
Test if two Object[]s are equal.
fieldName - the field namelhs - the left hand Object[]rhs - the right hand Object[]IllegalArgumentException - if field name is nullpublic DiffBuilder append(String fieldName, DiffResult diffResult)
Append diffs from another DiffResult.
This method is useful if you want to compare properties which are themselves Diffable and would like to know which specific part of it is different.
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();
}
}
fieldName - the field namediffResult - the DiffResult to appendIllegalArgumentException - if field name is nullpublic DiffResult build()
Builds a DiffResult based on the differences appended to this
builder.
build in interface Builder<DiffResult>DiffResult containing the differences between the two
objects.Copyright © 2001–2018 The Apache Software Foundation. All rights reserved.