Interface Path

All Superinterfaces:
Iterable<Path.Node>

public interface Path extends Iterable<Path.Node>
Represents the navigation path from an object to another in an object graph. Each path element is represented by a Node.

The path corresponds to the succession of nodes in the order they are returned by the Iterator.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Node representing a bean.
    static interface 
    Node representing a constructor.
    static interface 
    Node representing an element in a generic container such as Optional, List or Map.
    static interface 
    Node representing the element holding cross-parameter constraints of a method or constructor.
    static interface 
    Node representing a method.
    static interface 
    Represents an element of a navigation path.
    static interface 
    Node representing a parameter of a method or constructor.
    static interface 
    Node representing a property.
    static interface 
    Node representing the return value of a method or constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a human-readable representation of this path.

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator
  • Method Details

    • toString

      String toString()
      Returns a human-readable representation of this path.

      Clients should not rely on any specific structure of the returned value. Instead they should iterate through the path nodes and obtain any required information by calling the methods on Path.Node and its sub-types.

      Overrides:
      toString in class Object
      Returns:
      a human-readable representation of this path
      Since:
      2.0