AssertJ Core 3.26.0 · org.assertj.core.api.recursive.comparison.DualValue

Modifier and Type	Field and Description
pack-priv final Object	actual
pack-priv static final Class<?>[]	DEFAULT_ORDERED_COLLECTION_TYPES
pack-priv final Object	expected
pack-priv final FieldLocation	fieldLocation
private final int	hashCode

Access	Constructor and Description
public	DualValue(List<String> path, Object actual, Object expected)
public	DualValue(FieldLocation fieldLocation, Object actualFieldValue, Object expectedFieldValue)

Method Summary

Modifier and Type	Method and Description
private int	computeHashCode()
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getConcatenatedPath()
public List<String>	getDecomposedPath()
public String	getFieldName()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasNoContainerValues()
public boolean	hasNoNullValues()
public boolean	hasPotentialCyclingValues()
public boolean	hasSomeJavaTypeValue()
public boolean	isActualAnEnum()
public boolean	isActualFieldAMap()
public boolean	isActualFieldAnArray()
public boolean	isActualFieldAnAtomicBoolean()
public boolean	isActualFieldAnAtomicInteger()
public boolean	isActualFieldAnAtomicIntegerArray()
public boolean	isActualFieldAnAtomicLong()
public boolean	isActualFieldAnAtomicLongArray()
public boolean	isActualFieldAnAtomicReference()
public boolean	isActualFieldAnAtomicReferenceArray()
private boolean	isActualFieldAnEmptyOptional()
private boolean	isActualFieldAnEmptyOptionalDouble()
private boolean	isActualFieldAnEmptyOptionalInt()
private boolean	isActualFieldAnEmptyOptionalLong()
public boolean	isActualFieldAnEmptyOptionalOfAnyType()
public boolean	isActualFieldAnIterable()
public boolean	isActualFieldAnOptional()
public boolean	isActualFieldAnOptionalDouble()
public boolean	isActualFieldAnOptionalInt()
public boolean	isActualFieldAnOptionalLong()
public boolean	isActualFieldAnOrderedCollection()
public boolean	isActualFieldASortedMap()
public boolean	isActualJavaType()
private static boolean	isAJsonValueNode(Object value)
private static boolean	isAnIterable(Object value)
private static boolean	isAnObjectNode(Object value)
private static boolean	isAnOrderedCollection(Object value)
public boolean	isExpectedAContainer()
public boolean	isExpectedAnEnum()
public boolean	isExpectedFieldAMap()
public boolean	isExpectedFieldAnArray()
public boolean	isExpectedFieldAnAtomicBoolean()
public boolean	isExpectedFieldAnAtomicInteger()
public boolean	isExpectedFieldAnAtomicIntegerArray()
public boolean	isExpectedFieldAnAtomicLong()
public boolean	isExpectedFieldAnAtomicLongArray()
public boolean	isExpectedFieldAnAtomicReference()
public boolean	isExpectedFieldAnAtomicReferenceArray()
public boolean	isExpectedFieldAnIterable()
public boolean	isExpectedFieldAnOptional()
public boolean	isExpectedFieldAnOrderedCollection()
public boolean	isExpectedFieldASortedMap()
public boolean	isExpectedJavaType()
private static boolean	isJavaType(Object o)
private static boolean	isPotentialCyclingValue(Object object)
pack-priv static DualValue	rootDualValue(Object actual, Object expected)
public boolean	Returns: true if dual values references the same values (ignoring the field location) sameValues(DualValue the `DualValue` to compare dualValue) If we want to detect potential cycles in the recursive comparison, we need to check if an object has already been visited.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

actual	back to summary
pack-priv final Object actual

DEFAULT_ORDERED_COLLECTION_TYPES	back to summary
pack-priv static final Class<?>[] DEFAULT_ORDERED_COLLECTION_TYPES

expected	back to summary
pack-priv final Object expected

fieldLocation	back to summary
pack-priv final FieldLocation fieldLocation

hashCode	back to summary
private final int hashCode

DualValue	back to summary
public DualValue(List<String> path, Object actual, Object expected)

DualValue	back to summary
public DualValue(FieldLocation fieldLocation, Object actualFieldValue, Object expectedFieldValue)

Method Detail

computeHashCode	back to summary
private int computeHashCode()

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getConcatenatedPath	back to summary
public String getConcatenatedPath()

getDecomposedPath	back to summary
public List<String> getDecomposedPath()

getFieldName	back to summary
public String getFieldName()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

hasNoContainerValues	back to summary
public boolean hasNoContainerValues()

hasNoNullValues	back to summary
public boolean hasNoNullValues()

hasPotentialCyclingValues	back to summary
public boolean hasPotentialCyclingValues()

hasSomeJavaTypeValue	back to summary
public boolean hasSomeJavaTypeValue()

isActualAnEnum	back to summary
public boolean isActualAnEnum()

isActualFieldAMap	back to summary
public boolean isActualFieldAMap()

isActualFieldAnArray	back to summary
public boolean isActualFieldAnArray()

isActualFieldAnAtomicBoolean	back to summary
public boolean isActualFieldAnAtomicBoolean()

isActualFieldAnAtomicInteger	back to summary
public boolean isActualFieldAnAtomicInteger()

isActualFieldAnAtomicIntegerArray	back to summary
public boolean isActualFieldAnAtomicIntegerArray()

isActualFieldAnAtomicLong	back to summary
public boolean isActualFieldAnAtomicLong()

isActualFieldAnAtomicLongArray	back to summary
public boolean isActualFieldAnAtomicLongArray()

isActualFieldAnAtomicReference	back to summary
public boolean isActualFieldAnAtomicReference()

isActualFieldAnAtomicReferenceArray	back to summary
public boolean isActualFieldAnAtomicReferenceArray()

isActualFieldAnEmptyOptional	back to summary
private boolean isActualFieldAnEmptyOptional()

isActualFieldAnEmptyOptionalDouble	back to summary
private boolean isActualFieldAnEmptyOptionalDouble()

isActualFieldAnEmptyOptionalInt	back to summary
private boolean isActualFieldAnEmptyOptionalInt()

isActualFieldAnEmptyOptionalLong	back to summary
private boolean isActualFieldAnEmptyOptionalLong()

isActualFieldAnEmptyOptionalOfAnyType	back to summary
public boolean isActualFieldAnEmptyOptionalOfAnyType()

isActualFieldAnIterable	back to summary
public boolean isActualFieldAnIterable()

isActualFieldAnOptional	back to summary
public boolean isActualFieldAnOptional()

isActualFieldAnOptionalDouble	back to summary
public boolean isActualFieldAnOptionalDouble()

isActualFieldAnOptionalInt	back to summary
public boolean isActualFieldAnOptionalInt()

isActualFieldAnOptionalLong	back to summary
public boolean isActualFieldAnOptionalLong()

isActualFieldAnOrderedCollection	back to summary
public boolean isActualFieldAnOrderedCollection()

isActualFieldASortedMap	back to summary
public boolean isActualFieldASortedMap()

isActualJavaType	back to summary
public boolean isActualJavaType()

isAJsonValueNode	back to summary
private static boolean isAJsonValueNode(Object value)

isAnIterable	back to summary
private static boolean isAnIterable(Object value)

isAnObjectNode	back to summary
private static boolean isAnObjectNode(Object value)

isAnOrderedCollection	back to summary
private static boolean isAnOrderedCollection(Object value)

isExpectedAContainer	back to summary
public boolean isExpectedAContainer()

isExpectedAnEnum	back to summary
public boolean isExpectedAnEnum()

isExpectedFieldAMap	back to summary
public boolean isExpectedFieldAMap()

isExpectedFieldAnArray	back to summary
public boolean isExpectedFieldAnArray()

isExpectedFieldAnAtomicBoolean	back to summary
public boolean isExpectedFieldAnAtomicBoolean()

isExpectedFieldAnAtomicInteger	back to summary
public boolean isExpectedFieldAnAtomicInteger()

isExpectedFieldAnAtomicIntegerArray	back to summary
public boolean isExpectedFieldAnAtomicIntegerArray()

isExpectedFieldAnAtomicLong	back to summary
public boolean isExpectedFieldAnAtomicLong()

isExpectedFieldAnAtomicLongArray	back to summary
public boolean isExpectedFieldAnAtomicLongArray()

isExpectedFieldAnAtomicReference	back to summary
public boolean isExpectedFieldAnAtomicReference()

isExpectedFieldAnAtomicReferenceArray	back to summary
public boolean isExpectedFieldAnAtomicReferenceArray()

isExpectedFieldAnIterable	back to summary
public boolean isExpectedFieldAnIterable()

isExpectedFieldAnOptional	back to summary
public boolean isExpectedFieldAnOptional()

isExpectedFieldAnOrderedCollection	back to summary
public boolean isExpectedFieldAnOrderedCollection()

isExpectedFieldASortedMap	back to summary
public boolean isExpectedFieldASortedMap()

isExpectedJavaType	back to summary
public boolean isExpectedJavaType()

isJavaType	back to summary
private static boolean isJavaType(Object o)

isPotentialCyclingValue	back to summary
private static boolean isPotentialCyclingValue(Object object)

rootDualValue	back to summary
pack-priv static DualValue rootDualValue(Object actual, Object expected)

sameValues back to summary

public boolean sameValues(DualValue dualValue)

If we want to detect potential cycles in the recursive comparison, we need to check if an object has already been visited.

We must ignore the FieldLocation otherwise we would not find cycles. Let's take for example a Person class with a neighbor field. We have a cycle between the person instance and its neighbor instance, ex: Jack has Tim as neighbor and vice versa, when we navigate to Tim we find that its neighbor is Jack, we have already visited it but the location is different, Jack is both the root object and root.neighbor.neighbor (Jack=root, Tim=root.neighbor and Tim.neighbor=Jack)

Parameters