Class ComparingFields
- java.lang.Object
-
- org.assertj.core.api.recursive.comparison.ComparingFields
-
- All Implemented Interfaces:
RecursiveComparisonIntrospectionStrategy
public class ComparingFields extends java.lang.Object implements RecursiveComparisonIntrospectionStrategy
ARecursiveComparisonIntrospectionStrategy
that introspects fields including inherited ones but ignores static and synthetic fields.
-
-
Field Summary
Fields Modifier and Type Field Description static ComparingFields
COMPARING_FIELDS
-
Constructor Summary
Constructors Constructor Description ComparingFields()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
getChildNodeValue(java.lang.String childNodeName, java.lang.Object instance)
Returns the value of the given object child node, the child node being identified by the childNodeName parameter.java.util.Set<java.lang.String>
getChildrenNodeNamesOf(java.lang.Object node)
Returns the names of the children nodes of the given object that will be used in the recursive comparison.java.lang.String
getDescription()
Returns a human-readable description of the strategy to be used in error messages.
-
-
-
Field Detail
-
COMPARING_FIELDS
public static final ComparingFields COMPARING_FIELDS
-
-
Method Detail
-
getChildrenNodeNamesOf
public java.util.Set<java.lang.String> getChildrenNodeNamesOf(java.lang.Object node)
Description copied from interface:RecursiveComparisonIntrospectionStrategy
Returns the names of the children nodes of the given object that will be used in the recursive comparison.A typical implementation could look at the object fields or properties.
- Specified by:
getChildrenNodeNamesOf
in interfaceRecursiveComparisonIntrospectionStrategy
- Parameters:
node
- the object to get the child nodes from- Returns:
- the names of the children nodes of the given object
-
getChildNodeValue
public java.lang.Object getChildNodeValue(java.lang.String childNodeName, java.lang.Object instance)
Description copied from interface:RecursiveComparisonIntrospectionStrategy
Returns the value of the given object child node, the child node being identified by the childNodeName parameter.It's the implementor choice how to resolve the child node value, a typical implementation consists of considering childNodeName to be a field name and then use introspection to read the field value, but if the object is a Map the implementation could consider the child node name to be a key of the map.
- Specified by:
getChildNodeValue
in interfaceRecursiveComparisonIntrospectionStrategy
- Parameters:
childNodeName
- the child node identifierinstance
- the object to read the child node from- Returns:
- the object child node value
-
getDescription
public java.lang.String getDescription()
Description copied from interface:RecursiveComparisonIntrospectionStrategy
Returns a human-readable description of the strategy to be used in error messages.The default implementation returns
this.getClass().getSimpleName()
.- Specified by:
getDescription
in interfaceRecursiveComparisonIntrospectionStrategy
- Returns:
- a description of the strategy
-
-