Record Class Property<N>

java.lang.Object
java.lang.Record
ca.marcusdunn.jsonlens.model.Property<N>
Type Parameters:
N - the node type of the JSON model
Record Components:
name - the member name
value - the member value
public record Property<N>(JsonString name, N value) extends Record

A member of a JSON object: a name and a value (RFC 9535, Section 1.1).

The name is a JsonString in the representation of the model, so a model over bytes does not have to decode each name. Use JsonString.of(String) for a String name.

Two properties are equal if their names have the same scalar values and their values are equal.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Property(JsonString name, N value)
    Creates an instance of a Property record class.

  • Method Summary

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

    Methods inherited from class Object

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

  • Constructor Details

    • Property

      public Property(JsonString name, N value)
      Creates an instance of a Property record class.
      Parameters:
      name - the value for the name record component
      value - the value for the value record component

  • Method Details

    • equals

      public boolean equals(@Nullable Object other)
      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:
      other - the object with which to compare
      Returns:
      true if this object is the same as the other argument; false otherwise.

    • hashCode

      public 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

    • toString

      public 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

    • name

      public JsonString name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • value

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