Record Class DataPath.Index

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.common.config.DataPath.Index
Record Components:
value - The zero-based integer index.
All Implemented Interfaces:
DataPath.Segment
Enclosing class:
DataPath
public static record DataPath.Index(int value) extends Record implements DataPath.Segment
Represents an array or list positional index.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Index(int value)
    Creates an instance of a Index record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    isIndex()
     
    final String
    toString()
    Returns a string representation of this record class.
    int
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Index

      public Index(int value)
      Creates an instance of a Index record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • isIndex

      public boolean isIndex()
      Specified by:
      isIndex in interface DataPath.Segment
      Returns:
      True if this segment targets a list position, false if it targets a map key.

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • value

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