de.alpharogroup.evaluate.object.evaluators

Class EqualsHashCodeAndToStringEvaluator

java.lang.Object

de.alpharogroup.evaluate.object.evaluators.EqualsHashCodeAndToStringEvaluator

public final class EqualsHashCodeAndToStringEvaluator
extends Object

The class EqualsHashCodeAndToStringEvaluator is a combination of all evaluators.

Constructor Summary

Constructors

Constructor and Description
EqualsHashCodeAndToStringEvaluator()

Method Summary

Modifier and Type	Method and Description
static <T> boolean	evaluateEqualsAndHashcode(T first, T second, T third, T fourth) Evaluates the all the contract conditions for the methods Object.equals(Object) and Object.hashCode().
static <T> boolean	evaluateEqualsAndHashcodeEquality(T object, T otherObject) Evaluates the contract conditions for reflexivity, non null, symmetric and consistency of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition: It is reflexive: for any non-null reference value x, x.equals(x) should return true.
static <T> boolean	evaluateEqualsAndHashcodeUnequality(T object, T otherObject) Evaluates the contract conditions for reflexivity, non null, symmetric and consistency of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition: It is reflexive: for any non-null reference value x, x.equals(x) should return true.
static <T> boolean	evaluateEqualsHashcodeAndToString(Class<T> cls) Evaluates all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() from the given Class.
static <T> boolean	evaluateEqualsHashcodeAndToString(Class<T> cls, Function<Class<T>,T> function) Evaluates all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() from the given Class.
static <T> boolean	evaluateEqualsHashcodeAndToString(T object) Deprecated. use instead the EqualsEvaluator.evaluateReflexivityAndNonNull method in combination with the HashcodeEvaluator.evaluateConsistency and the ToStringEvaluator.evaluateConsistency method. Note: will be removed in the next minor version
static <T> boolean	evaluateEqualsHashcodeAndToString(T first, T second, T third, T fourth) Evaluates the all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString().
static <T> boolean	evaluateEqualsHashcodeEqualityAndToString(T object, T otherObject, T anotherObject) Deprecated. use instead the evaluateEqualsHashcodeAndToString method Note: will be removed in the next minor version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EqualsHashCodeAndToStringEvaluator

public EqualsHashCodeAndToStringEvaluator()

Method Detail

evaluateEqualsAndHashcode

public static <T> boolean evaluateEqualsAndHashcode(T first,
                                                    T second,
                                                    T third,
                                                    T fourth)

Evaluates the all the contract conditions for the methods Object.equals(Object) and Object.hashCode().

Type Parameters:

T - the generic type

Parameters:

first - the first object

second - the second object that have to be uneqal to the first object

third - the third object have to be equal to first object and fourth object

fourth - the fourth object have to be equal to first object and third object

Returns:

true, if all contract conditions for the methods Object.equals(Object) and Object.hashCode() is given otherwise false

evaluateEqualsAndHashcodeEquality

public static <T> boolean evaluateEqualsAndHashcodeEquality(T object,
                                                            T otherObject)

Evaluates the contract conditions for reflexivity, non null, symmetric and consistency of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• For any non-null reference value x, x.equals(null) should return false.
• 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 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.

Note: The upper list entries is taken from the javadoc from Object.equals(Object) Evaluate equality of hash code from the given objects that should be equal(if not an IllegalArgumentException will be thrown), that means according to Object.hashCode() that this method should evaluate the following contract condition:

• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.

Type Parameters:

T - the generic type

Parameters:

object - the object

otherObject - the other object

Returns:

true, if reflexivity, non null, symmetric and consistency contract conditions and equality of hash code from the given objects is given otherwise false

evaluateEqualsAndHashcodeUnequality

public static <T> boolean evaluateEqualsAndHashcodeUnequality(T object,
                                                              T otherObject)

Evaluates the contract conditions for reflexivity, non null, symmetric and consistency of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• For any non-null reference value x, x.equals(null) should return false.
• 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 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.

Note: The upper list entries is taken from the javadoc from Object.equals(Object) Evaluate unequality of hash code from the given objects that should be unequal(if not an IllegalArgumentException will be thrown), that means according to Object.hashCode() that this method should evaluate the following contract condition:

• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) 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.

Type Parameters:

T - the generic type

Parameters:

object - the object

otherObject - the other object

Returns:

true, if reflexivity, non null, symmetric and consistency contract conditions and unequality of hash code from the given objects is given otherwise false

evaluateEqualsHashcodeAndToString

public static <T> boolean evaluateEqualsHashcodeAndToString(Class<T> cls)
                                                     throws NoSuchMethodException,
                                                            IllegalAccessException,
                                                            InvocationTargetException,
                                                            InstantiationException,
                                                            IOException

Evaluates all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() from the given Class.

Type Parameters:

T - the generic type

Parameters:

cls - the class

Returns:

true, if all contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() is given otherwise false

Throws:

IllegalAccessException - if the caller does not have access to the property accessor method

InstantiationException - if a new instance of the bean's class cannot be instantiated

InvocationTargetException - if the property accessor method throws an exception

NoSuchMethodException - if an accessor method for this property cannot be found

IOException - Signals that an I/O exception has occurred.

evaluateEqualsHashcodeAndToString

public static <T> boolean evaluateEqualsHashcodeAndToString(Class<T> cls,
                                                            Function<Class<T>,T> function)
                                                     throws NoSuchMethodException,
                                                            IllegalAccessException,
                                                            InvocationTargetException,
                                                            InstantiationException,
                                                            IOException

Evaluates all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() from the given Class.

Type Parameters:

T - the generic type

Parameters:

cls - the class

function - the function that can create random objects

Returns:

true, if all contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() is given otherwise false

Throws:

NoSuchMethodException - if an accessor method for this property cannot be found

IllegalAccessException - if the caller does not have access to the property accessor method

InvocationTargetException - if the property accessor method throws an exception

InstantiationException - if a new instance of the bean's class cannot be instantiated

IOException - Signals that an I/O exception has occurred.

evaluateEqualsHashcodeAndToString

@Deprecated
public static <T> boolean evaluateEqualsHashcodeAndToString(T object)

Deprecated. use instead the EqualsEvaluator.evaluateReflexivityAndNonNull method in combination with the HashcodeEvaluator.evaluateConsistency and the ToStringEvaluator.evaluateConsistency method.

Note: will be removed in the next minor version

Evaluates the contract conditions for reflexivity and non null, that means according to Object.equals(Object) that this method should evaluate the following contract condition:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• For any non-null reference value x, x.equals(null) should return false.

Note: The upper list entries is taken from the javadoc from Object.equals(Object) Evaluate consistency of the given object, that means according to Object.hashCode() that this method should evaluate the following contract condition:

• 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.

Note: The upper list is taken from the javadoc from Object.hashCode()

Type Parameters:

T - the generic type

Parameters:

object - the object

Returns:

true, if reflexivity and non-null contract conditions from Object.equals(Object) and the consistency contract condition of Object.hashCode() is given otherwise false

evaluateEqualsHashcodeAndToString

public static <T> boolean evaluateEqualsHashcodeAndToString(T first,
                                                            T second,
                                                            T third,
                                                            T fourth)

Evaluates the all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString().

Type Parameters:

T - the generic type

Parameters:

first - the first object

second - the second object that have to be uneqal to the first object

third - the third object have to be equal to first object and fourth object

fourth - the fourth object have to be equal to first object and third object

Returns:

true, if all contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() is given otherwise false

evaluateEqualsHashcodeEqualityAndToString

@Deprecated
public static <T> boolean evaluateEqualsHashcodeEqualityAndToString(T object,
                                                                                T otherObject,
                                                                                T anotherObject)

Deprecated. use instead the evaluateEqualsHashcodeAndToString method

Note: will be removed in the next minor version

Evaluate consistency of method Object.toString() for the given objects
Evaluate consistency of the given object, that means according to Object.hashCode() that this method should evaluate the following contract condition:

• 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.

Note: The upper list is taken from the javadoc from Object.hashCode() Evaluate equality of hash code from the given objects that should be equal(if not an IllegalArgumentException will be thrown), that means according to Object.hashCode() that this method should evaluate the following contract condition:

• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.

Evaluates the contract conditions for reflexivity, non null, symmetric, consistency and transitivity of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• For any non-null reference value x, x.equals(null) should return false.
• 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 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.
• 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.

Note: The upper list entries is taken from the javadoc from Object.equals(Object)

Type Parameters:

T - the generic type

Parameters:

object - the object

otherObject - the other object

anotherObject - the another object

Returns:

true, if consistency of method Object.toString() for the given objects and if consistency contract condition of Object.hashCode() is given and if equality of hash code from the given objects is given and if reflexivity, non null, symmetric, consistency and transitivity contract conditions is given otherwise false