de.alpharogroup.evaluate.object.evaluators

Class EqualsEvaluator

java.lang.Object

de.alpharogroup.evaluate.object.evaluators.EqualsEvaluator

public final class EqualsEvaluator
extends Object

The class EqualsEvaluator provides algorithms for evaluate the equals contract of an given object.

Constructor Summary

Constructors

Constructor and Description
EqualsEvaluator()

Method Summary

Modifier and Type	Method and Description
static <T> boolean	evaluateConsistency(T object, T anotherObject) Evaluates the contract condition for consistency of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition: 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.
static <T> boolean	evaluateConsistency(T object, T anotherObject, int iterations) Evaluates the contract condition for consistency of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition: 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.
static <T> boolean	evaluateNonNull(T object) Evaluates the contract condition for non-null condition is given of the given object, that means according to Object.equals(Object) that this method should evaluate the following contract condition: For any non-null reference value x, x.equals(null) should return false.
static <T> boolean	evaluateReflexivity(T object) Evaluates the contract condition for reflexivity of the given object, 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	evaluateReflexivityAndNonNull(T object) 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.
static <T> boolean	evaluateReflexivityNonNullSymmetricAndConsistency(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	evaluateReflexivityNonNullSymmetricConsistencyAndTransitivity(T object, T otherObject, T anotherObject) 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.
static <T> boolean	evaluateSymmetric(T object, T anotherObject) Evaluates the contract condition for symmetric of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition: 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.
static <T> boolean	evaluateSymmetricAndConsistency(T object, T anotherObject) Evaluates the contract conditions for 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 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.
static <T> boolean	evaluateTransitivity(T a, T b, T c) Evaluates the contract condition for transitivity of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition: 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

EqualsEvaluator

public EqualsEvaluator()

Method Detail

evaluateReflexivity

public static <T> boolean evaluateReflexivity(T object)

Evaluates the contract condition for reflexivity of the given object, 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.

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

Type Parameters:

T - the generic type

Parameters:

object - the object

Returns:

true, if reflexivity contract condition is given otherwise false

evaluateSymmetric

public static <T> boolean evaluateSymmetric(T object,
                                            T anotherObject)

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

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

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

Type Parameters:

T - the generic type

Parameters:

object - the object

anotherObject - the another object

Returns:

true, if symmetric contract condition is given otherwise false

evaluateTransitivity

public static <T> boolean evaluateTransitivity(T a,
                                               T b,
                                               T c)

Evaluates the contract condition for transitivity of the given objects, that means according to Object.equals(Object) that this method should evaluate the following contract condition:

• 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 entry is taken from the javadoc from Object.equals(Object)

Type Parameters:

T - the generic type

Parameters:

a - the object

b - other object

c - another object

Returns:

true, if transitivity contract condition is given otherwise false

evaluateNonNull

public static <T> boolean evaluateNonNull(T object)

Evaluates the contract condition for non-null condition is given of the given object, that means according to Object.equals(Object) that this method should evaluate the following contract condition:

• For any non-null reference value x, x.equals(null) should return false.

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

Type Parameters:

T - the generic type

Parameters:

object - the object

Returns:

true, if non-null contract condition is given otherwise false

evaluateConsistency

public static <T> boolean evaluateConsistency(T object,
                                              T anotherObject)

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

• 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 entry is taken from the javadoc from Object.equals(Object)

This method calls the same name method with default iterations of 7

Type Parameters:

T - the generic type

Parameters:

object - the object

anotherObject - the another object

Returns:

true, if consistency contract condition is given otherwise false

evaluateConsistency

public static <T> boolean evaluateConsistency(T object,
                                              T anotherObject,
                                              int iterations)

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

• 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 entry is taken from the javadoc from Object.equals(Object)

Type Parameters:

T - the generic type

Parameters:

object - the object

anotherObject - the another object

iterations - the iterations of call of equals method.

Returns:

true, if consistency contract condition is given otherwise false

evaluateReflexivityAndNonNull

public static <T> boolean evaluateReflexivityAndNonNull(T object)

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)

Type Parameters:

T - the generic type

Parameters:

object - the object

Returns:

true, if reflexivity and non-null contract conditions is given otherwise false

evaluateSymmetricAndConsistency

public static <T> boolean evaluateSymmetricAndConsistency(T object,
                                                          T anotherObject)

Evaluates the contract conditions for 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 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)

Type Parameters:

T - the generic type

Parameters:

object - the object

anotherObject - the another object

Returns:

true, if symmetric and consistency contract conditions is given otherwise false

evaluateReflexivityNonNullSymmetricAndConsistency

public static <T> boolean evaluateReflexivityNonNullSymmetricAndConsistency(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)

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 is given otherwise false

evaluateReflexivityNonNullSymmetricConsistencyAndTransitivity

public static <T> boolean evaluateReflexivityNonNullSymmetricConsistencyAndTransitivity(T object,
                                                                                        T otherObject,
                                                                                        T anotherObject)

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 reflexivity, non null, symmetric, consistency and transitivity contract conditions is given otherwise false