Package com.kazforge.jsonapi.patch

Record Class StructuredMember

java.lang.Object
java.lang.Record
com.kazforge.jsonapi.patch.StructuredMember
public record StructuredMember(String wireName, String logicalName, StructuredMemberState state) extends Record
Backend-independent supplied nested member of a StructuredPatch. The current Jackson adapters populate it through caller-configured Jackson.

Both names are carried because they serve different purposes: wireName() is the final JSON:API document member name (used for wire lookup and diagnostics), and logicalName() is the logical application-property identity on the application type (used for application-property correspondence). Configured Jackson performs the translation between the logical identity and the final member name via its external property name; there is deliberately no single ambiguous name field and no third external-name field.

  • Constructor Details

    • StructuredMember

      public StructuredMember(String wireName, String logicalName, StructuredMemberState state)
      Creates an instance of a StructuredMember record class.
      Parameters:
      wireName - the value for the wireName record component
      logicalName - the value for the logicalName record component
      state - the value for the state 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.

    • wireName

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

    • logicalName

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

    • state

      public StructuredMemberState state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component