de.danielbechler.diff

Class Configuration

java.lang.Object

de.danielbechler.diff.Configuration

public class Configuration
extends Object

Author:

Daniel Bechler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Configuration.CircularReferenceMatchingMode Defines how the CircularReferenceDetector compares object instances.
static class	Configuration.PrimitiveDefaultValueMode Defines how default values of primitive types (int, long, short, byte, char, boolean, float, double) will be treated.

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Methods

Modifier and Type	Method and Description
Configuration.CircularReferenceMatchingMode	getCircularReferenceMatchingMode()
String	getEqualsOnlyValueProviderMethod(Node node)
ExceptionListener	getExceptionListener()
Configuration.PrimitiveDefaultValueMode	getPrimitiveDefaultValueMode()
boolean	hasEqualsOnlyValueProviderMethod(Node node)
boolean	isCompareToOnly(Node node)
boolean	isEqualsOnly(Node node)
boolean	isExcluded(Node node)
boolean	isIgnored(Node node)
boolean	isIncluded(Node node)
boolean	isIntrospectible(Node node)
boolean	isReturnable(Node node)
void	matchCircularReferencesUsing(Configuration.CircularReferenceMatchingMode circularReferenceMatchingMode)
Configuration	treatPrimitiveDefaultValuesAs(Configuration.PrimitiveDefaultValueMode mode)
Configuration	withCategory(String category)
Configuration	withChildrenOfAddedNodes()
Configuration	withChildrenOfRemovedNodes()
Configuration	withCircularNodes()
Configuration	withCompareToOnlyType(Class<?> type)
Configuration	withEqualsOnlyProperty(PropertyPath propertyPath)
Configuration	withEqualsOnlyType(Class<?> type)
Configuration	withEqualsOnlyValueProviderMethod(Class<?> type, String method)
Configuration	withEqualsOnlyValueProviderMethod(ClassAndMethod classAndMethod)
Configuration	withEqualsOnlyValueProviderMethod(PropertyPathAndMethod propertyPathEqualsMethod)
Configuration	withEqualsOnlyValueProviderMethod(PropertyPath propertyPath, String methodName)
Configuration	withExceptionListener(ExceptionListener exceptionListener) Sets handler for recoverable exceptional states.
Configuration	withIgnoredNodes()
Configuration	withoutCategory(String... category)
Configuration	withoutChildrenOfAddedNodes()
Configuration	withoutChildrenOfRemovedNodes()
Configuration	withoutCircularNodes()
Configuration	withoutIgnoredNodes()
Configuration	withoutProperty(PropertyPath propertyPath) Adds the property at the given path to the list of excluded properties.
Configuration	withoutUntouchedNodes()
Configuration	withPropertyPath(PropertyPath propertyPath) Adds the property at the given path to the list of included properties.
Configuration	withUntouchedNodes()

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

withExceptionListener

public Configuration withExceptionListener(ExceptionListener exceptionListener)

Sets handler for recoverable exceptional states.

Parameters:

exceptionListener - Handler for recoverable exceptional states.

Returns:

Modified configuration object.

withCategory

public Configuration withCategory(String category)

withoutCategory

public Configuration withoutCategory(String... category)

withPropertyPath

public Configuration withPropertyPath(PropertyPath propertyPath)

Adds the property at the given path to the list of included properties.

Parameters:

propertyPath - The property path to include.

Returns:

This configuration instance.

withoutProperty

public Configuration withoutProperty(PropertyPath propertyPath)

Adds the property at the given path to the list of excluded properties.

Parameters:

propertyPath - The property path to exclude.

Returns:

This configuration instance.

withCompareToOnlyType

public Configuration withCompareToOnlyType(Class<?> type)

withEqualsOnlyType

public Configuration withEqualsOnlyType(Class<?> type)

withEqualsOnlyProperty

public Configuration withEqualsOnlyProperty(PropertyPath propertyPath)

withEqualsOnlyValueProviderMethod

public Configuration withEqualsOnlyValueProviderMethod(PropertyPath propertyPath,
                                              String methodName)

withEqualsOnlyValueProviderMethod

public Configuration withEqualsOnlyValueProviderMethod(PropertyPathAndMethod propertyPathEqualsMethod)

withEqualsOnlyValueProviderMethod

public Configuration withEqualsOnlyValueProviderMethod(Class<?> type,
                                              String method)

withEqualsOnlyValueProviderMethod

public Configuration withEqualsOnlyValueProviderMethod(ClassAndMethod classAndMethod)

withIgnoredNodes

public Configuration withIgnoredNodes()

withoutIgnoredNodes

public Configuration withoutIgnoredNodes()

withUntouchedNodes

public Configuration withUntouchedNodes()

withoutUntouchedNodes

public Configuration withoutUntouchedNodes()

withCircularNodes

public Configuration withCircularNodes()

withoutCircularNodes

public Configuration withoutCircularNodes()

withChildrenOfAddedNodes

public Configuration withChildrenOfAddedNodes()

withoutChildrenOfAddedNodes

public Configuration withoutChildrenOfAddedNodes()

withChildrenOfRemovedNodes

public Configuration withChildrenOfRemovedNodes()

withoutChildrenOfRemovedNodes

public Configuration withoutChildrenOfRemovedNodes()

treatPrimitiveDefaultValuesAs

public Configuration treatPrimitiveDefaultValuesAs(Configuration.PrimitiveDefaultValueMode mode)

getPrimitiveDefaultValueMode

public Configuration.PrimitiveDefaultValueMode getPrimitiveDefaultValueMode()

getCircularReferenceMatchingMode

public Configuration.CircularReferenceMatchingMode getCircularReferenceMatchingMode()

matchCircularReferencesUsing

public void matchCircularReferencesUsing(Configuration.CircularReferenceMatchingMode circularReferenceMatchingMode)

isIgnored

public boolean isIgnored(Node node)

isIncluded

public boolean isIncluded(Node node)

isExcluded

public boolean isExcluded(Node node)

isCompareToOnly

public boolean isCompareToOnly(Node node)

isEqualsOnly

public boolean isEqualsOnly(Node node)

hasEqualsOnlyValueProviderMethod

public boolean hasEqualsOnlyValueProviderMethod(Node node)

getEqualsOnlyValueProviderMethod

public String getEqualsOnlyValueProviderMethod(Node node)

isReturnable

public boolean isReturnable(Node node)

isIntrospectible

public boolean isIntrospectible(Node node)

Returns:

Returns true if the object represented by the given node should be compared via introspection. It must always return false if isEqualsOnly(de.danielbechler.diff.node.Node) returns true.

getExceptionListener

public ExceptionListener getExceptionListener()

Returns:

Handler for recoverable exceptional states.