de.alpharogroup.evaluate.object.checkers

Class EqualsHashCodeAndToStringCheck

java.lang.Object

de.alpharogroup.evaluate.object.checkers.EqualsHashCodeAndToStringCheck

public final class EqualsHashCodeAndToStringCheck
extends Object

The class EqualsHashCodeAndToStringCheck is a combination of all checks.

Constructor Summary

Constructors

Constructor and Description
EqualsHashCodeAndToStringCheck()

Method Summary

Modifier and Type	Method and Description
static <T> Optional<ContractViolation>	equalsAndHashcode(T first, T second, T third, T fourth) Checks all the contract conditions for the methods Object.equals(Object) and Object.hashCode().
static <T> Optional<ContractViolation>	equalsAndHashcodeEquality(T object, T otherObject) Checks 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> Optional<ContractViolation>	equalsAndHashcodeUnequality(T object, T otherObject) Checks 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> Optional<ContractViolation>	equalsHashcodeAndToString(Class<T> cls) Checks all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() from the given Class.
static <T> Optional<ContractViolation>	equalsHashcodeAndToString(Class<T> cls, Function<Class<T>,T> function) Checks all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString() from the given Class.
static <T> Optional<ContractViolation>	equalsHashcodeAndToString(T object) Checks 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.
static <T> Optional<ContractViolation>	equalsHashcodeAndToString(T first, T second, T third, T fourth) Checks the all the contract conditions for the methods Object.equals(Object), Object.hashCode() and Object.toString().
static <T> Optional<ContractViolation>	hashcodeCheck(T first, T second, T fourth) Checks all the contract conditions for the method Object.hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

EqualsHashCodeAndToStringCheck

public EqualsHashCodeAndToStringCheck()

Method Detail

equalsAndHashcode

public static <T> Optional<ContractViolation> equalsAndHashcode(T first,
                                                                T second,
                                                                T third,
                                                                T fourth)

Checks 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:

an empty Optional if no violation occurred or an Optional with the specific violation type

hashcodeCheck

public static <T> Optional<ContractViolation> hashcodeCheck(T first,
                                                            T second,
                                                            T fourth)

Checks all the contract conditions for the method 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

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

Returns:

an empty Optional if no violation occurred or an Optional with the specific violation type

equalsAndHashcodeEquality

public static <T> Optional<ContractViolation> equalsAndHashcodeEquality(T object,
                                                                        T otherObject)

Checks 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:

an empty Optional if no violation occurred or an Optional with the specific violation type

equalsAndHashcodeUnequality

public static <T> Optional<ContractViolation> equalsAndHashcodeUnequality(T object,
                                                                          T otherObject)

Checks 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:

an empty Optional if no violation occurred or an Optional with the specific violation type

equalsHashcodeAndToString

public static <T> Optional<ContractViolation> equalsHashcodeAndToString(Class<T> cls)
                                                                 throws NoSuchMethodException,
                                                                        IllegalAccessException,
                                                                        InvocationTargetException,
                                                                        InstantiationException,
                                                                        IOException

Checks 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:

an empty Optional if no violation occurred or an Optional with the specific violation type

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

equalsHashcodeAndToString

public static <T> Optional<ContractViolation> equalsHashcodeAndToString(Class<T> cls,
                                                                        Function<Class<T>,T> function)
                                                                 throws NoSuchMethodException,
                                                                        IllegalAccessException,
                                                                        InvocationTargetException,
                                                                        InstantiationException,
                                                                        IOException

Checks 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:

an empty Optional if no violation occurred or an Optional with the specific violation type

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

equalsHashcodeAndToString

public static <T> Optional<ContractViolation> equalsHashcodeAndToString(T object)

Checks 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:

an empty Optional if no violation occurred or an Optional with the specific violation type

equalsHashcodeAndToString

public static <T> Optional<ContractViolation> equalsHashcodeAndToString(T first,
                                                                        T second,
                                                                        T third,
                                                                        T fourth)

Checks 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