Record Class Node<N>

java.lang.Object
java.lang.Record
ca.marcusdunn.jsonlens.path.evaluator.Node<N>
Type Parameters:
N - the node type of the JSON model
Record Components:
value - the JSON value, as the caller's own node instance
path - the Normalized Path of the location
public record Node<N>(N value, NormalizedPath path) extends Record

A node: a JSON value and its location in the query argument (RFC 9535, Section 1.1).

The value is the caller's own node instance, not a copy. The path is the one Normalized Path of the location. The same node can occur more than one time in a nodelist, for example for the query $[0, 0].

JsonPathQuery query = query("$..book[?@.isbn].author");
List<Node<JsonNode>> nodes = JsonPathEvaluator.standard()
        .evaluate(query, root, JacksonJsonModel.INSTANCE)
        .orElse(List.of());

Node<JsonNode> first = nodes.getFirst();
JsonNode value = first.value();          // the Jackson node "Herman Melville" of the tree
NormalizedPath path = first.path();      // $['store']['book'][2]['author']

  • Constructor Details

    • Node

      public Node(N value, NormalizedPath path)
      Creates an instance of a Node record class.
      Parameters:
      value - the value for the value record component
      path - the value for the path record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • value

      public N value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • path

      public NormalizedPath path()
      Returns the value of the path record component.
      Returns:
      the value of the path record component