Top Description Fields Constructors Methods
org.assertj.core.api.recursive.comparison

public final Class FieldLocation

extends Object
implements Comparable<FieldLocation>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Static Imports
java.util.Collections.emptyList, .Collections.unmodifiableList, .Collections.unmodifiableSet, .Objects.requireNonNull, java.util.stream.Collectors.joining, org.assertj.core.util.Lists.list, .Sets.newLinkedHashSet
Represents the path to a given field. Immutable

Field Summary

Modifier and TypeField and Description
private final List<String>
decomposedPath

private final Set<String>
pathsHierarchyToUseInRules

private final String
pathToUseInRules

Constructor Summary

AccessConstructor and Description
public
FieldLocation(List<String> path)

public
FieldLocation(String s)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(final FieldLocation
the object to be compared.
other)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public boolean
exactlyMatches(FieldLocation field)

public boolean
exactlyMatches(String fieldPath)

public FieldLocation
field(String field)

public List<String>
getDecomposedPath()

public String
getFieldName()

public String
getPathToUseInErrorReport()

public String
getPathToUseInRules()

public boolean

Returns:

true if this has the given child (direct or indirect), false otherwise.
hasChild(FieldLocation
the field to check for being a child
child)

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean

Returns:

true if this has the given parent (direct or indirect), false otherwise.
hasParent(FieldLocation
the field to check for being a parent
parent)

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

public boolean

Returns:

true if this fieldLocation is the given fieldPath or a child of it, false otherwise.
hierarchyMatches(String
the field path to test
fieldPath)

Checks whether this fieldLocation or any of its parents matches the given fieldPath.

public boolean

Returns:

true, this fieldLocation or any of its parent matches the given regex., false otherwise.
hierarchyMatchesRegex(Pattern
the regex to test
regex)

Checks whether this fieldLocation or any of its parents matches the given regex.

public boolean
isRoot()

private boolean
isRootPath(String pathToUseInRules)

public boolean
isTopLevelField()

public boolean

Returns:

true if it exactly matches this field, false otherwise
matches(String
field path to check
fieldPath)

Deprecated use exactlyMatches(String) instead.
Reruns true if it exactly matches this field, false otherwise.
public boolean

Returns:

true if it exactly matches this field, false otherwise
matches(FieldLocation
field to check
field)

Deprecated use exactlyMatches(String) instead.
Reruns true if it exactly matches this field, false otherwise.
private String
parent(String currentPath)

private Set<String>
pathsHierarchyToUseInRules()

private static String
pathToUseInRules(List<String> path)

public static FieldLocation
rootFieldLocation()

public String
shortDescription()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

decomposedPathback to summary
private final List<String> decomposedPath
pathsHierarchyToUseInRulesback to summary
private final Set<String> pathsHierarchyToUseInRules
pathToUseInRulesback to summary
private final String pathToUseInRules

Constructor Detail

FieldLocationback to summary
public FieldLocation(List<String> path)
FieldLocationback to summary
public FieldLocation(String s)

Method Detail

compareToback to summary
public int compareTo(final FieldLocation other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters
other:FieldLocation

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • 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 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.
  • 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.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
exactlyMatchesback to summary
public boolean exactlyMatches(FieldLocation field)
exactlyMatchesback to summary
public boolean exactlyMatches(String fieldPath)
fieldback to summary
public FieldLocation field(String field)
getDecomposedPathback to summary
public List<String> getDecomposedPath()
getFieldNameback to summary
public String getFieldName()
getPathToUseInErrorReportback to summary
public String getPathToUseInErrorReport()
getPathToUseInRulesback to summary
public String getPathToUseInRules()
hasChildback to summary
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:FieldLocation

the field to check for being a child

Returns:boolean

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

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
hasParentback to summary
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:FieldLocation

the field to check for being a parent

Returns:boolean

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

hierarchyMatchesback to summary
public boolean hierarchyMatches(String fieldPath)

Checks whether this fieldLocation or any of its parents matches the given fieldPath.

Examples: 


| fieldLocation       | fieldPath    | matches?
-----------------------------------------------
| name.first          | "name"       | true
| name.first.nickname | "name"       | true
| name.first          | "name.first" | true
| name.first.nickname | "name.first" | true
| name                | "name"       | true
| name                | "name.first" | false
| person.name         | "name"       | false
| names               | "name"       | false
| nickname            | "name"       | false
| name                | "nickname"   | false
| first.nickname      | "name"       | false
Parameters
fieldPath:String

the field path to test

Returns:boolean

true if this fieldLocation is the given fieldPath or a child of it, false otherwise.

hierarchyMatchesRegexback to summary
public boolean hierarchyMatchesRegex(Pattern regex)

Checks whether this fieldLocation or any of its parents matches the given regex.

Examples: 


| fieldLocation       | regex        | matches?
-----------------------------------------------
| name.first          | "name"       | true
| name.first          | "..me"       | true
| name.first.nickname | "name"       | true
| name.first          | "name.first" | true
| name.first.nickname | "name.first" | true
| name                | "name"       | true
| name                | "name.first" | false
| person.name         | "name"       | false
| names               | "name"       | false
| nickname            | "name"       | false
| name                | "nickname"   | false
| first.nickname      | "name"       | false
Parameters
regex:Pattern

the regex to test

Returns:boolean

true, this fieldLocation or any of its parent matches the given regex., false otherwise.

isRootback to summary
public boolean isRoot()
isRootPathback to summary
private boolean isRootPath(String pathToUseInRules)
isTopLevelFieldback to summary
public boolean isTopLevelField()
matchesback to summary
public boolean matches(String fieldPath)

Deprecated

use exactlyMatches(String) instead.

Reruns true if it exactly matches this field, false otherwise.

Parameters
fieldPath:String

field path to check

Returns:boolean

true if it exactly matches this field, false otherwise

Annotations
@Deprecated
matchesback to summary
public boolean matches(FieldLocation field)

Deprecated

use exactlyMatches(String) instead.

Reruns true if it exactly matches this field, false otherwise.

Parameters
field:FieldLocation

field to check

Returns:boolean

true if it exactly matches this field, false otherwise

Annotations
@Deprecated
parentback to summary
private String parent(String currentPath)
pathsHierarchyToUseInRulesback to summary
private Set<String> pathsHierarchyToUseInRules()
pathToUseInRulesback to summary
private static String pathToUseInRules(List<String> path)
rootFieldLocationback to summary
public static FieldLocation rootFieldLocation()
shortDescriptionback to summary
public String shortDescription()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override