Package me.datafox.dfxengine.math.numeral

Class IntNumeral

java.lang.Object
me.datafox.dfxengine.math.numeral.IntNumeral
All Implemented Interfaces:
Comparable<Numeral>, Numeral
public final class IntNumeral extends Object
Implementation of Numeral backed with an int.

  • Constructor Details

    • IntNumeral

      public IntNumeral(int number)
      Parameters:
      number - int to be associated with this numeral

  • Method Details

    • getNumber

      public Number getNumber()
      Returns:
      the Number backing this numeral

    • intValue

      public int intValue()
      Specified by:
      intValue in interface Numeral
      Returns:
      the backing int of this numeral

    • getLogger

      protected org.slf4j.Logger getLogger()
      Returns:
      Logger for this numeral

    • getType

      public NumeralType getType()
      Specified by:
      getType in interface Numeral
      Returns:
      the backing Number's type

    • canConvert

      public boolean canConvert(NumeralType type)
      Specified by:
      canConvert in interface Numeral
      Parameters:
      type - type to be checked for
      Returns:
      true if this numeral can be converted to the specified type
      Throws:
      NullPointerException - if the specified type is null
      IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

    • convert

      public Numeral convert(NumeralType type)
      Specified by:
      convert in interface Numeral
      Parameters:
      type - type for this numeral to be converted to
      Returns:
      a numeral backed with the specified type
      Throws:
      ExtendedArithmeticException - if the value of this numeral is outside the provided type's bounds
      NullPointerException - if the specified type is null
      IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

    • convertIfAllowed

      public Numeral convertIfAllowed(NumeralType type)
      Specified by:
      convertIfAllowed in interface Numeral
      Parameters:
      type - type for this numeral to be converted to
      Returns:
      a numeral backed with the specified type, unless the value of this numeral is outside the specified type's bounds, in which case this numeral is returned
      Throws:
      NullPointerException - if the specified type is null
      IllegalArgumentException - if the specified type is not null, but it is not recognised as any of the elements of NumeralType. This should never happen

    • toInteger

      public Numeral toInteger()
      Specified by:
      toInteger in interface Numeral
      Returns:
      a numeral backed with the smallest integer type that can hold this numeral's value, unless this numeral is already an integer, in which case this numeral is returned

    • toDecimal

      public Numeral toDecimal()
      Specified by:
      toDecimal in interface Numeral
      Returns:
      a numeral backed with the smallest decimal type that can hold this numeral's value, unless this numeral is already a decimal, in which case this numeral is returned

    • toSmallestType

      public Numeral toSmallestType()
      Specified by:
      toSmallestType in interface Numeral
      Returns:
      a numeral backed with the smallest type that can hold this numeral's value. This method does not convert between integer and decimal types.

    • longValue

      public long longValue()
      Specified by:
      longValue in interface Numeral
      Returns:
      the value of this numeral as a long
      Throws:
      ExtendedArithmeticException - if the value of this numeral is smaller than Long.MIN_VALUE or greater than Long.MAX_VALUE

    • bigIntValue

      public BigInteger bigIntValue()
      Specified by:
      bigIntValue in interface Numeral
      Returns:
      the value of this numeral as a BigInteger

    • floatValue

      public float floatValue()
      Specified by:
      floatValue in interface Numeral
      Returns:
      the value of this numeral as a float
      Throws:
      ExtendedArithmeticException - if the value of this numeral is smaller than -Float.MAX_VALUE or greater than Float.MAX_VALUE

    • doubleValue

      public double doubleValue()
      Specified by:
      doubleValue in interface Numeral
      Returns:
      the value of this numeral as a double
      Throws:
      ExtendedArithmeticException - if the value of this numeral is smaller than -Double.MAX_VALUE or greater than Double.MAX_VALUE

    • bigDecValue

      public BigDecimal bigDecValue()
      Specified by:
      bigDecValue in interface Numeral
      Returns:
      the value of this numeral as a BigDecimal

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      String representation of this numeral in format Type(value)

    • compareTo

      public int compareTo(Numeral other)
      Compares this numeral with the specified numeral for order. The numerals are compared using Numerals.compare(Numeral, Numeral). Returns a negative integer, zero, or a positive integer as this numeral is less than, equal to, or greater than the specified numeral.
      Specified by:
      compareTo in interface Comparable<Numeral>
      Parameters:
      other - the numeral to be compared
      Returns:
      a negative integer, zero, or a positive integer as this numeral is less than, equal to, or greater than the specified numeral
      Throws:
      NullPointerException - if the Numeral returns null for Numeral.getType()
      IllegalArgumentException - if the Numeral does not return null for Numeral.getType(), but the value is not recognised as any of the values of NumeralType. This should never happen