Package com.kazforge.jsonapi.representation

Record Class RelationshipAllowance

java.lang.Object
java.lang.Record
com.kazforge.jsonapi.representation.RelationshipAllowance
public record RelationshipAllowance(String resourceType, String relationshipName) extends Record
Allowance key for include-policy checks: owner JSON:API resource type plus relationship name.

resourceType is the JSON:API type of the relationship owner, not the target type and not a Java class name. Matched at every nested include-path segment.

  • Constructor Details

    • RelationshipAllowance

      public RelationshipAllowance(String resourceType, String relationshipName)
      Creates an instance of a RelationshipAllowance record class.
      Parameters:
      resourceType - the value for the resourceType record component
      relationshipName - the value for the relationshipName record component

  • Method Details

    • of

      public static RelationshipAllowance of(String resourceType, String relationshipName)

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

    • resourceType

      public String resourceType()
      Returns the value of the resourceType record component.
      Returns:
      the value of the resourceType record component

    • relationshipName

      public String relationshipName()
      Returns the value of the relationshipName record component.
      Returns:
      the value of the relationshipName record component