Top Description Fields Constructors Methods
org.assertj.core.internal

public Class ConfigurableRecursiveFieldByFieldComparator

extends Object
implements Comparator<Object>
Class Inheritance
All Implemented Interfaces
java.util.Comparator
Static Imports
java.lang.String.format, java.util.Objects.requireNonNull, org.assertj.core.internal.ComparatorBasedComparisonStrategy.NOT_EQUAL

Compares objects field/property by field/property recursively based on the given RecursiveComparisonConfiguration allowing fine tuning of the comparison.

Field Summary

Modifier and TypeField and Description
private RecursiveComparisonConfiguration
private RecursiveComparisonDifferenceCalculator

Constructor Summary

AccessConstructor and Description
pack-priv
public

Method Summary

Modifier and TypeMethod and Description
protected boolean
areEqual(Object actual, Object other)

public int
compare(Object
the first object to be compared.
actual
,
Object
the second object to be compared.
other
)

Implements java.util.Comparator.compare.

Compares its two arguments for order.
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Implements java.util.Comparator.equals.

Indicates whether some other object is "equal to" this comparator.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

configurationback to summary
private RecursiveComparisonConfiguration configuration
recursiveComparisonDifferenceCalculatorback to summary
private RecursiveComparisonDifferenceCalculator recursiveComparisonDifferenceCalculator

Constructor Detail

ConfigurableRecursiveFieldByFieldComparatorback to summary
pack-priv ConfigurableRecursiveFieldByFieldComparator(RecursiveComparisonConfiguration configuration, RecursiveComparisonDifferenceCalculator recursiveComparisonDifferenceCalculator)
ConfigurableRecursiveFieldByFieldComparatorback to summary
public ConfigurableRecursiveFieldByFieldComparator(RecursiveComparisonConfiguration configuration)

Method Detail

areEqualback to summary
protected boolean areEqual(Object actual, Object other)
compareback to summary
public int compare(Object actual, Object other)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

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

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

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

Parameters
actual:Object

the first object to be compared.

other:Object

the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Implements java.util.Comparator.equals.

Doc from java.util.Comparator.equals.

Indicates whether some other object is "equal to" this comparator. This method must obey the general contract of Object#equals(Object). Additionally, this method can return true only if the specified object is also a comparator and it imposes the same ordering as this comparator. Thus, comp1.equals(comp2) implies that signum(comp1.compare(o1, o2))==signum(comp2.compare(o1, o2)) for every object reference o1 and o2.

Note that it is always safe not to override Object.equals(Object). However, overriding this method may, in some cases, improve performance by allowing programs to determine that two distinct comparators impose the same order.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true only if the specified object is also a comparator and it imposes the same ordering as this comparator.

Annotations
@Override
hashCodeback 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
toStringback 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