com.radixdlt.client.application.translate.tokens

Class TokenUnitConversions

java.lang.Object

com.radixdlt.client.application.translate.tokens.TokenUnitConversions

public final class TokenUnitConversions
extends java.lang.Object

Utility class for converting token units between UInt256 and BigDecimal

Method Summary

Modifier and Type	Method and Description
static java.math.BigDecimal	getMinimumGranularity()
static java.math.BigDecimal	getSubunits()
static int	getTokenScale()
static java.math.BigDecimal	subunitsToUnits(java.math.BigInteger subunits) Returns the specified number of subunits as a fractional number of units.
static java.math.BigDecimal	subunitsToUnits(long subunits) Returns the specified number of subunits as a fractional number of units.
static java.math.BigDecimal	subunitsToUnits(UInt256 subunits) Returns the specified number of subunits as a fractional number of units.
static UInt256	unitsToSubunits(java.math.BigDecimal units) Returns the specified number of units as a UInt256 number of of subunits.
static UInt256	unitsToSubunits(long units) Returns the specified number of units as a UInt256 number of of subunits.

Methods inherited from class java.lang.Object

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

Method Detail

getTokenScale

public static int getTokenScale()

getSubunits

public static java.math.BigDecimal getSubunits()

getMinimumGranularity

public static java.math.BigDecimal getMinimumGranularity()

subunitsToUnits

public static java.math.BigDecimal subunitsToUnits(UInt256 subunits)

Returns the specified number of subunits as a fractional number of units. This method effectively calculates:

subunits × 10^{-SUB_UNITS_POW_10}

Parameters:

subunits - The number of subunits to convert to fractional units

Returns:

The number of fractional units represented by subunits

See Also:

SUB_UNITS_POW_10

subunitsToUnits

public static java.math.BigDecimal subunitsToUnits(java.math.BigInteger subunits)

Returns the specified number of subunits as a fractional number of units. This method effectively calculates:

subunits × 10^{-SUB_UNITS_POW_10}

Parameters:

subunits - The number of subunits to convert to fractional units

Returns:

The number of fractional units represented by subunits

See Also:

SUB_UNITS_POW_10

subunitsToUnits

public static java.math.BigDecimal subunitsToUnits(long subunits)

Returns the specified number of subunits as a fractional number of units. This method effectively calculates:

subunits × 10^{-SUB_UNITS_POW_10}

Parameters:

subunits - The number of subunits to convert to fractional units

Returns:

The number of fractional units represented by subunits

See Also:

SUB_UNITS_POW_10

unitsToSubunits

public static UInt256 unitsToSubunits(long units)

Returns the specified number of units as a UInt256 number of of subunits. This method effectively calculates:

units × 10^{SUB_UNITS_POW_10}

Parameters:

units - The number of units to convert to subunits

Returns:

The integer number of subunits represented by units

Throws:

java.lang.IllegalArgumentException - if units is less than zero

See Also:

SUB_UNITS_POW_10

unitsToSubunits

public static UInt256 unitsToSubunits(java.math.BigDecimal units)

Returns the specified number of units as a UInt256 number of of subunits. This method effectively calculates:

units × 10^{SUB_UNITS_POW_10}

Parameters:

units - The number of units to convert to subunits

Returns:

The integer number of subunits represented by units

Throws:

java.lang.IllegalArgumentException - if units is less than zero or greater than UInt256.MAX_VALUE

java.lang.ArithmeticException - if units × 10^{SUB_UNITS_POW_10} has a nonzero fractional part.

See Also:

SUB_UNITS_POW_10