Module com.darkcollective.relix.value
Package com.darkcollective.relix.value

Record Class StructValue

java.lang.Object
java.lang.Record
com.darkcollective.relix.value.StructValue
Record Components:
fields - the field map; never null, copied defensively and made unmodifiable
All Implemented Interfaces:
Value
public record StructValue(Map<String,Value> fields) extends Record implements Value
A runtime struct (nested object) value — an ordered map of field name to Value.

Field names are case-preserved but looked up case-insensitively via field(String). Equality is structural (two structs are equal when they have the same fields and values, regardless of field order). Like every nested value, its type() reports ScalarType.ANY (the dynamic-document type); pattern-match the Value itself to discover the structural kind.

  • Constructor Details

    • StructValue

      public StructValue(Map<String,Value> fields)
      Creates an instance of a StructValue record class.
      Parameters:
      fields - the value for the fields record component

  • Method Details

    • isNull

      public boolean isNull()
      Description copied from interface: Value
      Returns true if this value is null (absent).
      Specified by:
      isNull in interface Value
      Returns:
      whether this is a NullValue

    • type

      public ScalarType type()
      Description copied from interface: Value
      Returns the ScalarType that describes this value's kind. NullValue returns ScalarType.ANY.
      Specified by:
      type in interface Value
      Returns:
      the scalar type

    • asDisplayString

      public String asDisplayString()
      Description copied from interface: Value
      Returns a human-readable display string for this value, suitable for output formatting. NullValue returns "NULL".
      Specified by:
      asDisplayString in interface Value
      Returns:
      display string; never null

    • field

      public Optional<Value> field(String name)
      Returns the value of the field named name, matched case-insensitively.
      Parameters:
      name - the field name
      Returns:
      the field's value, or empty if the struct has no such field

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

    • fields

      public Map<String,Value> fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component