Record Class Ref<T>

java.lang.Object
java.lang.Record
org.moddingx.libx.util.Ref<T>
public record Ref<T>(T value) extends Record
A wrapper for an element that implements equals and hashCode for reference equality, no matter what the actual implementation of these methods does for the value of the Ref object.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Ref(T value)
    Creates an instance of a Ref record class.

  • Method Summary

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

    Methods inherited from class Object

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

  • Constructor Details

    • Ref

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

  • Method Details

    • equals

      public boolean equals(Object obj)
      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:
      obj - the object with which to compare
      Returns:
      true if this object is the same as the obj 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

    • value

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