Package me.datafox.dfxengine.math.utils

Class Conversion

java.lang.Object

me.datafox.dfxengine.math.utils.Conversion

public class Conversion
extends Object

Various conversion methods for Numerals.

Constructor Summary

Constructors

Constructor	Description
Conversion()

Method Summary

Modifier and Type	Method	Description
static BigDecimal	toBigDec(Numeral numeral)
static BigDecNumeral	toBigDecNumeral(Numeral numeral)
static BigInteger	toBigInt(Numeral numeral)
static BigIntNumeral	toBigIntNumeral(Numeral numeral)
static Numeral	toDecimal(Numeral numeral)
static double	toDouble(Numeral numeral)
static DoubleNumeral	toDoubleNumeral(Numeral numeral)
static float	toFloat(Numeral numeral)
static FloatNumeral	toFloatNumeral(Numeral numeral)
static int	toInt(Numeral numeral)
static Numeral	toInteger(Numeral numeral)
static IntNumeral	toIntNumeral(Numeral numeral)
static long	toLong(Numeral numeral)
static LongNumeral	toLongNumeral(Numeral numeral)
static Numeral	toNumeral(Numeral numeral, NumeralType type)
static Numeral	toSmallestType(Numeral numeral)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Conversion

public Conversion()

Method Details

toInt

public static int toInt(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

int representation of the specified value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than Integer.MIN_VALUE or greater than Integer.MAX_VALUE

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 elements of NumeralType. This should never happen

toLong

public static long toLong(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

long representation of the specified value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than Long.MIN_VALUE or greater than Long.MAX_VALUE

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 elements of NumeralType. This should never happen

toBigInt

public static BigInteger toBigInt(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

BigInteger representation of the specified value

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 elements of NumeralType. This should never happen

toFloat

public static float toFloat(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

float representation of the specified value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than -Float.MAX_VALUE or greater than Float.MAX_VALUE

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 elements of NumeralType. This should never happen

toDouble

public static double toDouble(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

double representation of the specified value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than -Double.MAX_VALUE or greater than Double.MAX_VALUE

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 elements of NumeralType. This should never happen

toBigDec

public static BigDecimal toBigDec(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

BigDecimal representation of the specified value

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 elements of NumeralType. This should never happen

toSmallestType

public static Numeral toSmallestType(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

a Numeral backed with the smallest type that can hold the specified Numeral's value. This method does not convert between integer and decimal types.

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 elements of NumeralType. This should never happen

toInteger

public static Numeral toInteger(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

a Numeral backed with the smallest integer type that can hold the specified Numeral's value, unless the Numeral is already an integer, in which case the specified Numeral is returned

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 elements of NumeralType. This should never happen

toDecimal

public static Numeral toDecimal(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

a Numeral backed with the smallest decimal type that can hold the specified Numeral's value, unless the Numeral is already a decimal, in which case the specified Numeral is returned

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 elements of NumeralType. This should never happen

toNumeral

public static Numeral toNumeral(Numeral numeral,
 NumeralType type)

Parameters:

numeral - Numeral to be converted

type - type for the Numeral to be converted to

Returns:

a Numeral backed with the specified type

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is outside the specified type's bounds

NullPointerException - if the specified type is null or if the Numeral returns null for Numeral.getType()

IllegalArgumentException - if the specified type is not null or if the Numeral does not return null for Numeral.getType(), but the value is not recognised as any of the elements of NumeralType. This should never happen

toIntNumeral

public static IntNumeral toIntNumeral(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

Numeral backed by an int with the specified Numeral's value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than Integer.MIN_VALUE or greater than Integer.MAX_VALUE

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 elements of NumeralType. This should never happen

toLongNumeral

public static LongNumeral toLongNumeral(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

Numeral backed by a long with the specified Numeral's value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than Long.MIN_VALUE or greater than Long.MAX_VALUE

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 elements of NumeralType. This should never happen

toBigIntNumeral

public static BigIntNumeral toBigIntNumeral(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

Numeral backed by a BigInteger with the specified Numeral's value

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 elements of NumeralType. This should never happen

toFloatNumeral

public static FloatNumeral toFloatNumeral(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

Numeral backed by a float with the specified Numeral's value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than -Float.MAX_VALUE or greater than Float.MAX_VALUE

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 elements of NumeralType. This should never happen

toDoubleNumeral

public static DoubleNumeral toDoubleNumeral(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

Numeral backed by a double with the specified Numeral's value

Throws:

ExtendedArithmeticException - if the value of the specified Numeral is smaller than -Double.MAX_VALUE or greater than Double.MAX_VALUE

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 elements of NumeralType. This should never happen

toBigDecNumeral

public static BigDecNumeral toBigDecNumeral(Numeral numeral)

Parameters:

numeral - Numeral to be converted

Returns:

Numeral backed by a BigDecimal with the specified Numeral's value

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 elements of NumeralType. This should never happen