Package dev.crafty.core.number

Record Class UnitNumber<T extends Enum<T> & UnitEnum<T>>

java.lang.Object
java.lang.Record
dev.crafty.core.number.UnitNumber<T>
Type Parameters:
T - The type of unit enum
public record UnitNumber<T extends Enum<T> & UnitEnum<T>>(Number value, T extends Enum<T> & UnitEnum<T> unit) extends Record
Represents a number with a specific unit.
Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    UnitNumber(Number value, T unit)
    Creates a new UnitNumber with the specified value and unit.

  • Method Summary

    Modifier and Type
    Method
    Description
    UnitNumber<T>
    convertTo(T targetUnit)
    Converts this UnitNumber to a different unit.
    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.
    static <T extends Enum<T> & UnitEnum<T>>
    UnitNumber<T>
    of(Number value, T unit)
     
    @NotNull String
    toString()
    Returns a string representation of this record class.
    T
    unit()
    Returns the value of the unit record component.
    Number
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • UnitNumber

      public UnitNumber(Number value, T unit)
      Creates a new UnitNumber with the specified value and unit.
      Parameters:
      value - The numeric value
      unit - The unit of the value

  • Method Details

    • convertTo

      public UnitNumber<T> convertTo(T targetUnit)
      Converts this UnitNumber to a different unit.
      Parameters:
      targetUnit - The unit to convert to
      Returns:
      A new UnitNumber with the converted value and target unit

    • toString

      @NotNull public @NotNull 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

    • of

      public static <T extends Enum<T> & UnitEnum<T>> UnitNumber<T> of(Number value, T unit)

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

    • value

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

    • unit

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