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

Field Summary

Modifier and Type	Field and Description
pack-priv final Object	actual
pack-priv final Optional<String>	additionalInformation
pack-priv final String	concatenatedPath
pack-priv final List<String>	decomposedPath
public static final String	DEFAULT_TEMPLATE
pack-priv final Object	expected
private static final String	FIELD
pack-priv final String	template
private static final String	TOP_LEVEL_ELEMENT_PATTERN
private static final String	TOP_LEVEL_ELEMENTS
private static final String	TOP_LEVEL_OBJECTS

Constructor Summary

Access	Constructor and Description
public	ComparisonDifference(DualValue dualValue)
public	ComparisonDifference(DualValue dualValue, String additionalInformation)
public	ComparisonDifference(DualValue dualValue, String additionalInformation, String template)
private	ComparisonDifference(List<String> decomposedPath, Object actual, Object other, String additionalInformation, String template)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(final ComparisonDifference the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
private static String	concat(List<String> decomposedPath)
public boolean	equals(final Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
private static String	extractIndex(String path)
protected String	fieldPathDescription()
private static String	formatOnNewline(String info)
public Object	getActual()
public Optional<String>	getAdditionalInformation()
public List<String>	getDecomposedPath()
public Object	getExpected()
public String	getTemplate()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	multiLineDescription()
public String	multiLineDescription(Representation representation)
public static ComparisonDifference	rootComparisonDifference(Object actual, Object other, String additionalInformation)
private static String	toConcatenatedPath(List<String> decomposedPath)
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

Field Detail

actual	back to summary
pack-priv final Object actual

additionalInformation	back to summary
pack-priv final Optional<String> additionalInformation

concatenatedPath	back to summary
pack-priv final String concatenatedPath

decomposedPath	back to summary
pack-priv final List<String> decomposedPath

DEFAULT_TEMPLATE	back to summary
public static final String DEFAULT_TEMPLATE

expected	back to summary
pack-priv final Object expected

FIELD	back to summary
private static final String FIELD

template	back to summary
pack-priv final String template

TOP_LEVEL_ELEMENT_PATTERN	back to summary
private static final String TOP_LEVEL_ELEMENT_PATTERN

TOP_LEVEL_ELEMENTS	back to summary
private static final String TOP_LEVEL_ELEMENTS

TOP_LEVEL_OBJECTS	back to summary
private static final String TOP_LEVEL_OBJECTS

Constructor Detail

ComparisonDifference	back to summary
public ComparisonDifference(DualValue dualValue)

ComparisonDifference	back to summary
public ComparisonDifference(DualValue dualValue, String additionalInformation)

ComparisonDifference	back to summary
public ComparisonDifference(DualValue dualValue, String additionalInformation, String template)

ComparisonDifference	back to summary
private ComparisonDifference(List<String> decomposedPath, Object actual, Object other, String additionalInformation, String template)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(final ComparisonDifference other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:ComparisonDifference the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(final ComparisonDifference other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:ComparisonDifference: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

concat	back to summary
private static String concat(List<String> decomposedPath)

equals back to summary

equals	back to summary
public boolean equals(final 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(final 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

extractIndex	back to summary
private static String extractIndex(String path)

fieldPathDescription	back to summary
protected String fieldPathDescription()

formatOnNewline	back to summary
private static String formatOnNewline(String info)

getActual	back to summary
public Object getActual()

getAdditionalInformation	back to summary
public Optional<String> getAdditionalInformation()

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

getExpected	back to summary
public Object getExpected()

getTemplate	back to summary
public String getTemplate()

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

multiLineDescription	back to summary
public String multiLineDescription()

multiLineDescription	back to summary
public String multiLineDescription(Representation representation)

rootComparisonDifference	back to summary
public static ComparisonDifference rootComparisonDifference(Object actual, Object other, String additionalInformation)

toConcatenatedPath	back to summary
private static String toConcatenatedPath(List<String> decomposedPath)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

public Class ComparisonDifference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail