Ion Java 1.11.10 · com.amazon.ion.IonNumber · APIdia, the JavaDoc alternative

Modifier and Type	Method and Description
public BigDecimal	Returns: the `BigDecimal` value, or `null` if `this.isNullValue()`. bigDecimalValue() Gets the value of this Ion number as a `BigDecimal`.
public boolean	Returns: a checked condition whether this value is numeric. isNumericValue() Determines whether this value is numeric.

Modifier and Type

Method and Description

Returns:

the BigDecimal value, or null if this.isNullValue().

Gets the value of this Ion number as a BigDecimal.

public boolean

Returns:

a checked condition whether this value is numeric.

Determines whether this value is numeric.

Method Detail

bigDecimalValue back to summary

bigDecimalValue	back to summary
public BigDecimal bigDecimalValue() Gets the value of this Ion number as a `BigDecimal`. This method will throw an exception for non-null, non-numeric values. It's recommended to call `isNumericValue()` before calling this method. Negative zero is supported by `IonDecimal` and `IonFloat`, but not by `BigDecimal`. If you need to distinguish positive and negative zero, you should call `IonDecimal#decimalValue()` or `IonFloat#doubleValue()` after casting to the appropriate type. Returns:BigDecimal the `BigDecimal` value, or `null` if `this.isNullValue()`. Exceptions NumberFormatException: if this value is `nan`, `+inf`, or `-inf`, because `BigDecimal` cannot represent those values.

public BigDecimal bigDecimalValue()

Gets the value of this Ion number as a BigDecimal.

This method will throw an exception for non-null, non-numeric values. It's recommended to call isNumericValue() before calling this method.

Negative zero is supported by IonDecimal and IonFloat, but not by BigDecimal. If you need to distinguish positive and negative zero, you should call IonDecimal#decimalValue() or IonFloat#doubleValue() after casting to the appropriate type.

the BigDecimal value, or null if this.isNullValue().

Exceptions

NumberFormatException:: if this value is nan, +inf, or -inf, because BigDecimal cannot represent those values.

isNumericValue back to summary

isNumericValue	back to summary
public boolean isNumericValue() Determines whether this value is numeric. Returns true if this value is none of `null`, `nan`, `+inf`, and `-inf`, and false if it is any of them. Returns:boolean a checked condition whether this value is numeric.

public boolean isNumericValue()

Determines whether this value is numeric. Returns true if this value is none of null, nan, +inf, and -inf, and false if it is any of them.