javax.json

Interface JsonNumber

All Superinterfaces:

JsonValue

public interface JsonNumber
extends JsonValue

JsonNumber represents an immutable JSON number value

A BigDecimal may be used to store the numeric value internally. The BigDecimal may be constructed using int, long, BigInteger, double and String. Some of the method semantics in this class are defined using the BigDecimal semantics.

Author:

Jitendra Kotamraju

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JsonNumber.NumberType JSON number type that is used to find out if a number is numerically integer or a decimal.

Nested classes/interfaces inherited from interface javax.json.JsonValue

JsonValue.ValueType

Field Summary

Fields inherited from interface javax.json.JsonValue

FALSE, NULL, TRUE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares the specified object with this JsonNumber for equality.
BigDecimal	getBigDecimalValue() Returns JSON number as a BigDecimal
BigInteger	getBigIntegerValue() Returns JSON number as a BigInteger number.
BigInteger	getBigIntegerValueExact() Returns JSON number as a BigDecimal number.
double	getDoubleValue() Returns JSON number as a double number.
int	getIntValue() Returns JSON number as an int number.
int	getIntValueExact() Returns JSON number as an int number.
long	getLongValue() Returns JSON number as a long number.
long	getLongValueExact() Returns JSON number as a long number.
JsonNumber.NumberType	getNumberType() Returns a JSON number type for this number.
int	hashCode() Returns the hash code value for this JsonNumber object.
String	toString() Returns a JSON representation of the JSON number value.

Methods inherited from interface javax.json.JsonValue

getValueType

Method Detail

getNumberType

JsonNumber.NumberType getNumberType()

Returns a JSON number type for this number. A BigDecimal may be used to store the numeric value internally and the semantics of this method is defined using BigDecimal.scale(). If the scale of a value is zero, then its number type is INTEGER else DECIMAL.

The number type can be used to invoke appropriate accessor methods to get numeric value for the number.

For example:

 
 switch(getNumberType()) {
     case INTEGER :
         long l = getLongValue(); break;
     case DECIMAL :
         BigDecimal bd = getBigDecimalValue(); break;
 }
 
 

Returns:

a number type

getIntValue

int getIntValue()

Returns JSON number as an int number. Note that this conversion can lose information about the overall magnitude and precision of the number value as well as return a result with the opposite sign.

Returns:

an int for JSON number.

See Also:

BigDecimal.intValue()

getIntValueExact

int getIntValueExact()

Returns JSON number as an int number.

Returns:

an int for JSON number

Throws:

ArithmeticException - cause if the number has a nonzero fractional part, or will not fit in an int

See Also:

BigDecimal.intValueExact()

getLongValue

long getLongValue()

Returns JSON number as a long number. Note that this conversion can lose information about the overall magnitude and precision of the number value as well as return a result with the opposite sign.

Returns:

a long for JSON number.

See Also:

BigDecimal.longValue()

getLongValueExact

long getLongValueExact()

Returns JSON number as a long number.

Returns:

a long for JSON number

Throws:

ArithmeticException - if the number has a nonzero fractional part, or will not fit in a long.

See Also:

BigDecimal.longValueExact()

getBigIntegerValue

BigInteger getBigIntegerValue()

Returns JSON number as a BigInteger number. It is more of a convenience method for getBigDecimalValue().toBigInteger(). Note that this conversion can lose information about the overall magnitude and precision of the number value as well as return a result with the opposite sign.

Returns:

a BigInteger for JSON number.

See Also:

BigDecimal.toBigInteger()

getBigIntegerValueExact

BigInteger getBigIntegerValueExact()

Returns JSON number as a BigDecimal number. It is more of a convenience method for getBigDecimalValue().toBigIntegerExact().

Returns:

a BigInteger for JSON number

Throws:

ArithmeticException - if the number has a nonzero fractional part.

See Also:

BigDecimal.toBigIntegerExact()

getDoubleValue

double getDoubleValue()

Returns JSON number as a double number. It is more of a convenience method for getBigDecimalValue().doubleValue(). Note that this conversion can lose information about the overall magnitude and precision of the number value as well as return a result with the opposite sign.

Returns:

a double for JSON number

See Also:

BigDecimal.doubleValue()

getBigDecimalValue

BigDecimal getBigDecimalValue()

Returns JSON number as a BigDecimal

Returns:

a BigDecimal for JSON number

toString

String toString()

Returns a JSON representation of the JSON number value. The representation would be equivalent to BigDecimal.toString().

Specified by:

toString in interface JsonValue

Overrides:

toString in class Object

Returns:

JSON representation of the number

equals

boolean equals(Object obj)

Compares the specified object with this JsonNumber for equality. Returns true if and only if the specified object is also a JsonNumber, and their getBigDecimalValue() objects are equal

Overrides:

equals in class Object

Parameters:

obj - the object to be compared for equality with this JsonNumber

Returns:

true if the specified object is equal to this JsonNumber

hashCode

int hashCode()

Returns the hash code value for this JsonNumber object. The hash code of a JsonNumber object is defined to be its getBigDecimalValue() object's hash code.

Overrides:

hashCode in class Object

Returns:

the hash code value for this JsonNumber object