de.danielbechler.diff.circular

Enum CircularReferenceMatchingMode

java.lang.Object

java.lang.Enum<CircularReferenceMatchingMode>

de.danielbechler.diff.circular.CircularReferenceMatchingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CircularReferenceMatchingMode>

public enum CircularReferenceMatchingMode
extends java.lang.Enum<CircularReferenceMatchingMode>

Defines how the CircularReferenceDetector compares object instances. The default is EQUALITY_OPERATOR and this should be sufficient in mose cases. However, you may be dealing with an object model that returns copies of its properties, instead of reusing the exact same instance. In this cases it would be easy to end up in infinite loops, as the default circular reference detection would not be able to detect this. In those cases you should switch to the EQUALS_METHOD mode. The trade-off is, that this renders you unable to nest equal but different objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUALITY_OPERATOR Compares objects using the == operator.
EQUALS_METHOD Compares objects using Object.equals(Object).

Method Summary

Modifier and Type	Method and Description
static CircularReferenceMatchingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CircularReferenceMatchingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQUALITY_OPERATOR

public static final CircularReferenceMatchingMode EQUALITY_OPERATOR

Compares objects using the == operator.

EQUALS_METHOD

public static final CircularReferenceMatchingMode EQUALS_METHOD

Compares objects using Object.equals(Object).

Method Detail

values

public static CircularReferenceMatchingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CircularReferenceMatchingMode c : CircularReferenceMatchingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CircularReferenceMatchingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null