Package foundation.omni

Class OmniIndivisibleValue

java.lang.Object

java.lang.Number

javax.money.NumberValue

foundation.omni.OmniValue

foundation.omni.OmniIndivisibleValue

All Implemented Interfaces:

Serializable, Comparable<javax.money.NumberValue>

public final class OmniIndivisibleValue
extends OmniValue

Numeric Value of Indivisible Omni Token An indivisible token is an integer number of tokens that can't be subdivided to less than one token.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final OmniIndivisibleValue	MAX
static final BigInteger	MAX_BIGINT
static final long	MAX_VALUE
static final OmniIndivisibleValue	MIN
static final BigInteger	MIN_BIGINT
static final long	MIN_VALUE
static final OmniIndivisibleValue	ZERO

Fields inherited from class foundation.omni.OmniValue

MAX_WILLETTS, MIN_WILLETTS, willetts, willettsPerDivisible

Method Summary

Modifier and Type	Method	Description
BigDecimal	bigDecimalValue()	Convert to a BigDecimal value.
static void	checkValue(long candidate)	Make sure a BigInteger value is a valid value for OmniIndivisibleValue
static void	checkValue(BigInteger candidate)	Make sure a BigInteger value is a valid value for OmniIndivisibleValue
double	doubleValue()	Return a double value.
double	doubleValueExact()
boolean	equals(Object obj)
Class<Long>	getNumberType()
PropertyType	getPropertyType()
OmniIndivisibleValue	minus(OmniIndivisibleValue right)
Long	numberValue()	Return value in preferred number type
static OmniIndivisibleValue	of(long amount)	Create OmniDivisibleValue of the specified amount
static OmniIndivisibleValue	of(BigInteger amount)
static OmniIndivisibleValue	ofWilletts(long willetts)	Create OmniIndivisibleValue from willetts/internal/wire format
OmniIndivisibleValue	plus(OmniIndivisibleValue right)
OmniIndivisibleValue	round(MathContext mathContext)
String	toFormattedString()	Convert to String.
String	toJsonFormattedString()	Convert to String.
String	toPlainString()	Convert to String.
String	toString()	Convert to String.

Methods inherited from class foundation.omni.OmniValue

byteValue, checkWillettValue, checkWillettValue, compareTo, floatValue, getAmountFractionDenominator, getAmountFractionNumerator, getPrecision, getScale, getWilletts, hashCode, intValue, intValueExact, longValue, longValueExact, minus, multiply, numberValue, numberValueExact, of, of, of, of, of, of, ofWilletts, ofWilletts, plus, shortValue

Methods inherited from class java.lang.Object

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

Field Details

MIN_VALUE

public static final long MIN_VALUE

See Also:

• Constant Field Values

MAX_VALUE

public static final long MAX_VALUE

See Also:

• Constant Field Values

MIN_BIGINT

public static final BigInteger MIN_BIGINT

MAX_BIGINT

public static final BigInteger MAX_BIGINT

ZERO

public static final OmniIndivisibleValue ZERO

MIN

public static final OmniIndivisibleValue MIN

MAX

public static final OmniIndivisibleValue MAX

Method Details

of

public static OmniIndivisibleValue of(BigInteger amount)

of

public static OmniIndivisibleValue of(long amount)

Create OmniDivisibleValue of the specified amount

Parameters:

amount - Number of Omni tokens

Returns:

OmniDivisibleValue representing amount tokens

ofWilletts

public static OmniIndivisibleValue ofWilletts(long willetts)

Create OmniIndivisibleValue from willetts/internal/wire format

Parameters:

willetts - number of willetts

Returns:

OmniIndivisibleValue equal to number of willetts

checkValue

public static void checkValue(BigInteger candidate)
                       throws ArithmeticException

Make sure a BigInteger value is a valid value for OmniIndivisibleValue

Parameters:

candidate - value to check

Throws:

ArithmeticException - if less than minimum or greater than maximum allowed value

checkValue

public static void checkValue(long candidate)
                       throws ArithmeticException

Make sure a BigInteger value is a valid value for OmniIndivisibleValue

Note: Since any positive long is valid, we just need to check that it's not less than MIN_VALUE

Parameters:

candidate - value to check.

Throws:

ArithmeticException - if less than minimum allowed value

equals

public boolean equals(Object obj)

Specified by:

equals in class OmniValue

toString

public String toString()

Convert to String. Uses standard JVM toString() formats. For OmniDivisibleValue it is the same format as BigDecimal (this means"0E-8" for OmniDivisibleValue.ZERO.) For OmniIndivisibleValue it is the same format as Long.

Specified by:

toString in class OmniValue

Returns:

Number as a string

toPlainString

public String toPlainString()

Convert to String. For OmniDivisibleValue the same format as BigDecimal.toPlainString(). For OmniIndivisibleValue it is the same as toString().

Specified by:

toPlainString in class OmniValue

Returns:

Number as a string

toJsonFormattedString

public String toJsonFormattedString()

Convert to String. The required format for OmniValues in JSON. For OmniDivisibleValue there is always at least one place after the decimal point (e.g. "0.0"). This allows humans and parsers to easily tell OmniDivisibleValues from OmniIndivisibleValues. Note: The '.' separator is always used regardless of the current Locale.

Specified by:

toJsonFormattedString in class OmniValue

Returns:

Number as a string

toFormattedString

public String toFormattedString()

Convert to String. A human-readable format using locale-specific place-separators.

Specified by:

toFormattedString in class OmniValue

Returns:

Number as a string

getNumberType

public Class<Long> getNumberType()

Specified by:

getNumberType in class OmniValue

doubleValueExact

public double doubleValueExact()

Specified by:

doubleValueExact in class OmniValue

doubleValue

public double doubleValue()

Return a double value. Warning: this will result in rounding errors. Only use this for applications like plotting data, never for anything that counts currency.

Specified by:

doubleValue in class OmniValue

Returns:

The value rounded to the nearest double.

round

public OmniIndivisibleValue round(MathContext mathContext)

Specified by:

round in class javax.money.NumberValue

numberValue

public Long numberValue()

Return value in preferred number type

Specified by:

numberValue in class OmniValue

Returns:

value as represented in best/preferred number type

bigDecimalValue

public BigDecimal bigDecimalValue()

Description copied from class: OmniValue

Convert to a BigDecimal value. This will be lossless. For OmniIndivisibleValue the BigDecimal value will be an integer, of course.

Specified by:

bigDecimalValue in class OmniValue

Returns:

the value

getPropertyType

public PropertyType getPropertyType()

Specified by:

getPropertyType in class OmniValue

Returns:

property type

plus

public OmniIndivisibleValue plus(OmniIndivisibleValue right)

minus

public OmniIndivisibleValue minus(OmniIndivisibleValue right)