org.assertj.core.api.recursive.comparison

Class FieldLocation

java.lang.Object

org.assertj.core.api.recursive.comparison.FieldLocation

All Implemented Interfaces:

Comparable<FieldLocation>

public final class FieldLocation
extends Object
implements Comparable<FieldLocation>

Represents the path to a given field. Immutable

Constructor Summary

Constructors

Constructor and Description
FieldLocation(List<String> path)
FieldLocation(String s)

Method Summary

Modifier and Type	Method and Description
int	compareTo(FieldLocation other)
boolean	equals(Object obj)
List<String>	getDecomposedPath()
String	getFieldName()
String	getPathToUseInRules()
boolean	hasChild(FieldLocation child) Returns true if this field has the given child (direct or indirect), false otherwise.
int	hashCode()
boolean	hasParent(FieldLocation parent) Returns true if this has the given parent (direct or indirect), false otherwise.
String	shortDescription()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldLocation

public FieldLocation(List<String> path)

FieldLocation

public FieldLocation(String s)

Method Detail

getDecomposedPath

public List<String> getDecomposedPath()

getPathToUseInRules

public String getPathToUseInRules()

compareTo

public int compareTo(FieldLocation other)

Specified by:

compareTo in interface Comparable<FieldLocation>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

shortDescription

public String shortDescription()

getFieldName

public String getFieldName()

hasParent

public boolean hasParent(FieldLocation parent)

Returns true if this has the given parent (direct or indirect), false otherwise.

Examples:

 | field                 | parent       | hasParent? 
 -----------------------------------------------  
 | "name.first"          | "name"       | true       
 | "name.first.nickname" | "name"       | true       
 | "name.first.nickname" | "name.first" | true       
 | "name"                | "name"       | false      
 | "names"               | "name"       | false      
 | "nickname"            | "name"       | false      
 | "name"                | "nickname"   | false      
 | "first.nickname"      | "name"       | false      
 

Parameters:

parent - the field to check for being a parent

Returns:

true if this has the given parent (direct or indirect), false otherwise.

hasChild

public boolean hasChild(FieldLocation child)

Returns true if this field has the given child (direct or indirect), false otherwise.

Examples:

 | field                 | child           | hasChild? 
 -----------------------------------------------  
 | "name"                | "name.first"    | true       
 | "name"                | "name.last"     | true       
 | "one"                 | "one.two.three" | true
 | "name.first"          | "name "         | false       
 | "name"                | "name"          | false      
 | "names"               | "name"          | false      
 | "nickname"            | "name"          | false      
 | "name"                | "nickname"      | false      
 | "first.nickname"      | "name"          | false      
 

Parameters:

child - the field to check for being a child

Returns:

true if this has the given child (direct or indirect), false otherwise.