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

Record Class ArrayValue

java.lang.Object
java.lang.Record
com.darkcollective.relix.value.ArrayValue
Record Components:
elements - the element list; never null, copied defensively
All Implemented Interfaces:
Value
public record ArrayValue(List<Value> elements) extends Record implements Value
A runtime array value — an ordered list of Value elements.

Equality is structural and order-sensitive. Like every nested value, its type() reports ScalarType.ANY (the dynamic-document type); pattern-match the Value itself to discover the structural kind. Elements are themselves Values (including NullValue for JSON null).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArrayValue(List<Value> elements)
    Creates an instance of a ArrayValue record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asDisplayString()
    Returns a human-readable display string for this value, suitable for output formatting.
    Optional<Value>
    at(int index)
    Returns the element at index, or empty if the index is out of range.
    List<Value>
    elements()
    Returns the value of the elements record component.
    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.
    boolean
    isNull()
    Returns true if this value is null (absent).
    final String
    toString()
    Returns a string representation of this record class.
    ScalarType
    type()
    Returns the ScalarType that describes this value's kind.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ArrayValue

      public ArrayValue(List<Value> elements)
      Creates an instance of a ArrayValue record class.
      Parameters:
      elements - the value for the elements 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

    • at

      public Optional<Value> at(int index)
      Returns the element at index, or empty if the index is out of range.
      Parameters:
      index - a zero-based index
      Returns:
      the element, or empty if index < 0 or index >= size

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

    • elements

      public List<Value> elements()
      Returns the value of the elements record component.
      Returns:
      the value of the elements record component