Record Class Float2

java.lang.Object
java.lang.Record
kr.toxicity.model.api.data.Float2
Record Components:
x - the x value
y - the y value
public record Float2(float x, float y) extends Record
A simple record representing two float values.
Since:
3.0.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.google.gson.JsonDeserializer<Float2>
    PARSER
    A GSON deserializer for Float2.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Float2(float x, float y)
    Creates an instance of a Float2 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.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull org.joml.Vector2f
    toVector()
    Converts this record to a Vector2f.
    float
    x()
    Returns the value of the x record component.
    float
    y()
    Returns the value of the y record component.

    Methods inherited from class Object

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

  • Field Details

    • PARSER

      public static final com.google.gson.JsonDeserializer<Float2> PARSER
      A GSON deserializer for Float2.
      Since:
      3.0.0

  • Constructor Details

    • Float2

      public Float2(float x, float y)
      Creates an instance of a Float2 record class.
      Parameters:
      x - the value for the x record component
      y - the value for the y record component

  • Method Details

    • toVector

      @NotNull public @NotNull org.joml.Vector2f toVector()
      Converts this record to a Vector2f.
      Returns:
      a new vector instance
      Since:
      3.0.0

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

    • x

      public float x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public float y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component