Package foundation.omni

Class OmniDivisibleValue

java.lang.Object

java.lang.Number

javax.money.NumberValue

foundation.omni.OmniValue

foundation.omni.OmniDivisibleValue

All Implemented Interfaces:

Serializable, Comparable<javax.money.NumberValue>

public final class OmniDivisibleValue
extends OmniValue

Numeric Value of Divisible Omni Token An Omni Divisible token is typically represented to the user as a decimal amount and hence you can have a fractional number of tokens. Internally it uses the same format as an indivisible token.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final MathContext	DEFAULT_CONTEXT
static final int	DEFAULT_SCALE
static OmniDivisibleValue	MAX
static final long	MAX_INT_VALUE
static final BigDecimal	MAX_VALUE
static OmniDivisibleValue	MIN
static final long	MIN_INT_VALUE
static final BigDecimal	MIN_VALUE
static OmniDivisibleValue	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.
byte	byteValue()
static void	checkValue(long candidate)	Make sure a long value is a valid value for OmniDivisibleValue
static void	checkValue(BigDecimal candidate)	Make sure a BigDecimal value is a valid value for OmniDivisibleValue
double	doubleValue()	Return a double value.
double	doubleValueExact()
boolean	equals(Object obj)
float	floatValue()
long	getAmountFractionDenominator()
long	getAmountFractionNumerator()
Class<BigDecimal>	getNumberType()
int	getPrecision()
PropertyType	getPropertyType()
int	getScale()
int	intValue()
int	intValueExact()
long	longValue()
long	longValueExact()
OmniDivisibleValue	minus(OmniDivisibleValue right)
BigDecimal	numberValue()	Return value in preferred number type
static OmniDivisibleValue	of(long amount)	Create OmniDivisibleValue of the specified amount
static OmniDivisibleValue	of(BigDecimal amount)	Create OmniDivisibleValue of the specified amount
static OmniDivisibleValue	ofWilletts(long willetts)	Create OmniDivisibleValue from willetts/internal/wire format
OmniDivisibleValue	plus(OmniDivisibleValue right)
OmniDivisibleValue	round(MathContext mathContext)
short	shortValue()
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

checkWillettValue, checkWillettValue, compareTo, getWilletts, hashCode, minus, multiply, numberValue, numberValueExact, of, of, of, of, of, of, ofWilletts, ofWilletts, plus

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CONTEXT

public static final MathContext DEFAULT_CONTEXT

DEFAULT_SCALE

public static final int DEFAULT_SCALE

See Also:

• Constant Field Values

MIN_VALUE

public static final BigDecimal MIN_VALUE

MAX_VALUE

public static final BigDecimal MAX_VALUE

MIN_INT_VALUE

public static final long MIN_INT_VALUE

See Also:

• Constant Field Values

MAX_INT_VALUE

public static final long MAX_INT_VALUE

See Also:

• Constant Field Values

ZERO

public static OmniDivisibleValue ZERO

MIN

public static OmniDivisibleValue MIN

MAX

public static OmniDivisibleValue MAX

Method Details

of

public static OmniDivisibleValue of(long amount)

Create OmniDivisibleValue of the specified amount

Parameters:

amount - Number of Omni tokens

Returns:

OmniDivisibleValue representing amount

of

public static OmniDivisibleValue of(BigDecimal amount)

Create OmniDivisibleValue of the specified amount

Parameters:

amount - Number of Omni tokens

Returns:

OmniDivisibleValue representing amount

ofWilletts

public static OmniDivisibleValue ofWilletts(long willetts)

Create OmniDivisibleValue from willetts/internal/wire format

Parameters:

willetts - number of willetts

Returns:

OmniIndivisibleValue equal to number of willetts

checkValue

public static void checkValue(BigDecimal candidate)
                       throws ArithmeticException

Make sure a BigDecimal value is a valid value for OmniDivisibleValue

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 long value is a valid value for OmniDivisibleValue

Parameters:

candidate - value to check.

Throws:

ArithmeticException - if less than minimum or greater than maximum 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 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 OmniIndivisibleValue.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

getPropertyType

public PropertyType getPropertyType()

Specified by:

getPropertyType in class OmniValue

Returns:

property type

getNumberType

public Class<BigDecimal> getNumberType()

Specified by:

getNumberType in class OmniValue

numberValue

public BigDecimal numberValue()

Return value in preferred number type

Specified by:

numberValue in class OmniValue

Returns:

value as represented in best/preferred number type

getPrecision

public int getPrecision()

Overrides:

getPrecision in class OmniValue

getScale

public int getScale()

Overrides:

getScale in class OmniValue

intValueExact

public int intValueExact()

Overrides:

intValueExact in class OmniValue

longValueExact

public long longValueExact()

Overrides:

longValueExact in class OmniValue

doubleValueExact

public double doubleValueExact()

Specified by:

doubleValueExact in class OmniValue

round

public OmniDivisibleValue round(MathContext mathContext)

Specified by:

round in class javax.money.NumberValue

getAmountFractionNumerator

public long getAmountFractionNumerator()

Overrides:

getAmountFractionNumerator in class OmniValue

getAmountFractionDenominator

public long getAmountFractionDenominator()

Overrides:

getAmountFractionDenominator in class OmniValue

byteValue

public byte byteValue()

Overrides:

byteValue in class OmniValue

shortValue

public short shortValue()

Overrides:

shortValue in class OmniValue

intValue

public int intValue()

Overrides:

intValue in class OmniValue

longValue

public long longValue()

Overrides:

longValue in class OmniValue

floatValue

public float floatValue()

Overrides:

floatValue 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.

bigDecimalValue

public BigDecimal bigDecimalValue()

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

plus

public OmniDivisibleValue plus(OmniDivisibleValue right)

minus

public OmniDivisibleValue minus(OmniDivisibleValue right)