Package com.kazforge.jsonapi.representation

Record Class IncludePath

java.lang.Object
java.lang.Record
com.kazforge.jsonapi.representation.IncludePath
public record IncludePath(List<String> segments) extends Record
An ordered include path of JSON:API relationship names.

Use of(String) to parse a dotted path such as comments.author. Syntax failures throw JsonApiMappingException with MappingDiagnostic.INVALID_INCLUDE_PATH.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IncludePath(List<String> segments)
    Creates an instance of a IncludePath record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    dotted()
    Returns the dotted JSON:API form of this path (for diagnostics).
    String
    dottedThrough(int segmentIndex)
    Returns the dotted form of the path prefix through segmentIndex (inclusive).
    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.
    static IncludePath
    of(String path)
    Parses a dotted include path.
    List<String>
    segments()
    Returns the value of the segments record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IncludePath

      public IncludePath(List<String> segments)
      Creates an instance of a IncludePath record class.
      Parameters:
      segments - the value for the segments record component

  • Method Details

    • of

      public static IncludePath of(String path)
      Parses a dotted include path. Does not trim or otherwise normalize input. Rejects empty input, leading or trailing dots, repeated dots, and whitespace-only segments.

    • dotted

      public String dotted()
      Returns the dotted JSON:API form of this path (for diagnostics).

    • dottedThrough

      public String dottedThrough(int segmentIndex)
      Returns the dotted form of the path prefix through segmentIndex (inclusive).

    • 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.

    • segments

      public List<String> segments()
      Returns the value of the segments record component.
      Returns:
      the value of the segments record component