Module uk.oczadly.karl.jnano

Package uk.oczadly.karl.jnano.util

Enum NanoUnit

java.lang.Object

java.lang.Enum<NanoUnit>

uk.oczadly.karl.jnano.util.NanoUnit

All Implemented Interfaces:

Serializable, Comparable<NanoUnit>

public enum NanoUnit
extends Enum<NanoUnit>

This class represents the currency units and denominations used to represent an amount of Nano, and can be used to locally convert between the different units.

If you are intending to parse or display an amount of Nano to the user, it is recommended that you use the BASE_UNIT constant, rather than explicitly specifying the unit. This constant represents the unit that users of Nano will be most familiar with.

Below are a few currency conversion examples:

   // Convert 1.337 knano (KILO) to the base unit (currently MEGA, or "Nano")
   BigDecimal conv1 = NanoUnit.BASE_UNIT
          .convertFrom(NanoUnit.KILO, new BigDecimal("1.337"));
   System.out.println("1337 knano = " + conv1.toPlainString() + " Nano"); // Prints 1337 knano = 0.001337 Nano

   // Convert 250 unano (MICRO) to raw (RAW)
   BigInteger conv2 = NanoUnit.RAW
          .convertFromInt(NanoUnit.MICRO, BigInteger.valueOf(250));
   System.out.println("250 unano = " + conv2.toString() + " raw"); // Prints 250 unano = 250000000000000000000 raw
 

Enum Constant Summary

Enum Constants

Enum Constant	Description
GIGA	The largest divisor, equivalent to 10^33 raw.
KILO	The 3rd largest divisor, equivalent to 10^27 raw.
MEGA	The 2nd largest divisor, equivalent to 10^30 raw.
MICRO	The 6th largest divisor, equivalent to 10^18 raw.
MILLI	The 5th largest divisor, equivalent to 10^21 raw.
RAW	The smallest possible representable unit.
XRB	The 4th largest divisor, equivalent to 10^24 raw.

Field Summary

Fields

Modifier and Type	Field	Description
static NanoUnit	BASE_UNIT	The standard base unit currently used by most services, block explorers and exchanges.

Method Summary

Modifier and Type	Method	Description
BigDecimal	convertFrom(NanoUnit sourceUnit, BigDecimal sourceAmount)	Converts the specified unit and amount into this unit.
BigDecimal	convertFrom(NanoUnit sourceUnit, BigInteger sourceAmount)	Converts the specified unit and amount into this unit.
BigInteger	convertFromInt(NanoUnit sourceUnit, BigDecimal sourceAmount)	Converts the specified unit and amount into this unit.
BigInteger	convertFromInt(NanoUnit sourceUnit, BigInteger sourceAmount)	Converts the specified unit and amount into this unit.
String	getClassicName()	Returns the classic legacy name used within previous versions of the node.
String	getDisplayName()	Returns the human-readable name for this currency unit.
int	getExponent()	Returns the exponent of the unit as a power of 10.
BigInteger	getRawValue()	Returns the equivalent value of a single unit in raw.
static String	toFriendlyString(BigDecimal amount, NanoUnit sourceUnit)	Converts a given quantity of Nano to the current base unit (BASE_UNIT), and formats the number to up to 6 decimal places (rounding up truncated digits), along with a suffix of the unit name.
static String	toFriendlyString(BigInteger rawAmount)	Converts a given value of raw to the current base unit (BASE_UNIT), and formats the number to up to 6 decimal places (rounding up truncated digits), along with a suffix of the unit name.
String	toString()
static NanoUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NanoUnit[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GIGA

public static final NanoUnit GIGA

The largest divisor, equivalent to 10^33 raw.

MEGA

public static final NanoUnit MEGA

The 2nd largest divisor, equivalent to 10^30 raw.

KILO

public static final NanoUnit KILO

The 3rd largest divisor, equivalent to 10^27 raw.

XRB

public static final NanoUnit XRB

The 4th largest divisor, equivalent to 10^24 raw.

MILLI

public static final NanoUnit MILLI

The 5th largest divisor, equivalent to 10^21 raw.

MICRO

public static final NanoUnit MICRO

The 6th largest divisor, equivalent to 10^18 raw.

RAW

public static final NanoUnit RAW

The smallest possible representable unit.

Field Detail

BASE_UNIT

public static final NanoUnit BASE_UNIT

The standard base unit currently used by most services, block explorers and exchanges.

End-users are likely to be most familiar with this unit, and it is recommended that this constant is used so your application can be automatically updated should the units system ever change.

As of this current version, this is equal to the MEGA unit.

Method Detail

values

public static NanoUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NanoUnit c : NanoUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NanoUnit valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getExponent

public int getExponent()

Returns the exponent of the unit as a power of 10.

For instance, 10^x, with x being the value returned by this method.

getRawValue

public BigInteger getRawValue()

Returns the equivalent value of a single unit in raw.

Returns:

the equivalent raw value of 1 unit

getDisplayName

public String getDisplayName()

Returns the human-readable name for this currency unit.

getClassicName

public String getClassicName()

Returns the classic legacy name used within previous versions of the node.

toString

public String toString()

Overrides:

toString in class Enum<NanoUnit>

convertFromInt

public BigInteger convertFromInt(NanoUnit sourceUnit,
                                 BigInteger sourceAmount)

Converts the specified unit and amount into this unit.

If you are converting from a smaller unit and fractional digits are lost, then an ArithmeticException will be thrown. If you wish to bypass this, use convertFrom(NanoUnit, BigInteger) and transform the retrieved value into a BigInteger using the BigDecimal.toBigInteger() method.

Parameters:

sourceAmount - the source amount to convert from

sourceUnit - the source unit to convert from

Returns:

the converted value in this unit

Throws:

ArithmeticException - if the conversion would result in a loss of information

convertFromInt

public BigInteger convertFromInt(NanoUnit sourceUnit,
                                 BigDecimal sourceAmount)

Converts the specified unit and amount into this unit.

If you are converting from a smaller unit and fractional digits are lost, then an ArithmeticException will be thrown. If you wish to bypass this, use convertFrom(NanoUnit, BigDecimal) and transform the retrieved value into a BigInteger using the BigDecimal.toBigInteger() method.

Parameters:

sourceAmount - the source amount to convert from

sourceUnit - the source unit to convert from

Returns:

the converted value in this unit

Throws:

ArithmeticException - if the conversion would result in a loss of information

convertFrom

public BigDecimal convertFrom(NanoUnit sourceUnit,
                              BigInteger sourceAmount)

Converts the specified unit and amount into this unit.

Parameters:

sourceAmount - the source amount to convert from

sourceUnit - the source unit to convert from

Returns:

the converted value in this unit

convertFrom

public BigDecimal convertFrom(NanoUnit sourceUnit,
                              BigDecimal sourceAmount)

Converts the specified unit and amount into this unit.

Parameters:

sourceAmount - the source amount to convert from

sourceUnit - the source unit to convert from

Returns:

the converted value in this unit

toFriendlyString

public static String toFriendlyString(BigInteger rawAmount)

Converts a given value of raw to the current base unit (BASE_UNIT), and formats the number to up to 6 decimal places (rounding up truncated digits), along with a suffix of the unit name. The value will also be formatted to contain separating commas for every 3 digits.

For instance, a value of 1234567000000000000000000000000001 will return 1,234.567001 Nano.

This value should not be used for any computations, and should only be used for displaying quantities of the currency to a user.

Parameters:

rawAmount - the amount of raw to convert from

Returns:

a friendly string of a given currency amount

toFriendlyString

public static String toFriendlyString(BigDecimal amount,
                                      NanoUnit sourceUnit)

Converts a given quantity of Nano to the current base unit (BASE_UNIT), and formats the number to up to 6 decimal places (rounding up truncated digits), along with a suffix of the unit name. The value will also be formatted to contain separating commas for every 3 digits.

For instance, a value of 1234567000000000000000000000000001 RAW will return 1,234.567001 Nano.

This value should not be used for any computations, and should only be used for displaying quantities of the currency to a user.

Parameters:

amount - the amount to convert from

sourceUnit - the source unit of the amount to convert from

Returns:

a friendly string of a given currency amount