Record Class JsonPathEvaluator.Limits

java.lang.Object
java.lang.Record
ca.marcusdunn.jsonlens.path.evaluator.JsonPathEvaluator.Limits
Record Components:
maxNodes - the maximum number of nodes in a nodelist
maxRegexSize - the maximum number of program instructions for a regular expression
Enclosing class:
JsonPathEvaluator
public static record JsonPathEvaluator.Limits(int maxNodes, int maxRegexSize) extends Record

Resource limits. When an evaluation passes a limit, the result is an overflow indication (RFC 9535, Section 2.1), not a wrong result.

Limit Error when the evaluation passes it
maxNodes() EvaluationError.NodelistTooLarge
maxRegexSize() EvaluationError.RegexTooComplex 
JsonPathEvaluator strict = JsonPathEvaluator.standard()
        .withLimits(new JsonPathEvaluator.Limits(5, 1_000)); // at most 5 nodes in a nodelist

String outcome = switch (strict.evaluate(query("$[*]"), root, JacksonJsonModel.INSTANCE)) {
    case Result.Ok(List<Node<JsonNode>> nodes) -> nodes.size() + " nodes";
    case Result.Err(EvaluationError.NodelistTooLarge(int limit)) -> "more than " + limit + " nodes";
    case Result.Err(EvaluationError.RegexTooComplex(String pattern, int limit)) -> "regexp too large: " + pattern;
    case Result.Err(EvaluationError error) -> error.message();
};
// outcome: "more than 5 nodes"

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final JsonPathEvaluator.Limits
    DEFAULT
    10,000,000 nodes and 10,000 regular expression instructions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Limits(int maxNodes, int maxRegexSize)
    Creates an instance of a Limits record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxNodes()
    Returns the value of the maxNodes record component.
    int
    maxRegexSize()
    Returns the value of the maxRegexSize record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

    • DEFAULT

      public static final JsonPathEvaluator.Limits DEFAULT
      10,000,000 nodes and 10,000 regular expression instructions.

  • Constructor Details

    • Limits

      public Limits(int maxNodes, int maxRegexSize)
      Creates an instance of a Limits record class.
      Parameters:
      maxNodes - the value for the maxNodes record component
      maxRegexSize - the value for the maxRegexSize 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 the compare method from their corresponding wrapper classes.
      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.

    • maxNodes

      public int maxNodes()
      Returns the value of the maxNodes record component.
      Returns:
      the value of the maxNodes record component

    • maxRegexSize

      public int maxRegexSize()
      Returns the value of the maxRegexSize record component.
      Returns:
      the value of the maxRegexSize record component