JsonDouble (embulk-spi 0.11 API)

java.lang.Object
- org.embulk.spi.json.JsonDouble

All Implemented Interfaces:

JsonNumber, JsonValue
```
public final class JsonDouble
extends Object
implements JsonNumber
```
Represents a number in JSON, represented by a Java primitive double, which is the same as Embulk's DOUBLE column type.
It does not accept NaN (Not-a-Number) and the infinity.

Since:

0.10.42

See Also:

RFC 8259 - The JavaScript Object Notation (JSON) Data Interchange Format

Nested Class Summary
- Nested classes/interfaces inherited from interface org.embulk.spi.json.JsonValue
  JsonValue.EntityType

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JsonDouble`	`asJsonDouble()` Returns this value as `JsonDouble`.
`BigDecimal`	`bigDecimalValue()` Returns this JSON number as `BigDecimal`.
`BigInteger`	`bigIntegerValue()` Returns this JSON number as a `BigInteger`.
`BigInteger`	`bigIntegerValueExact()` Returns this JSON number as a `BigInteger`.
`byte`	`byteValue()` Returns this JSON number as a Java primitive `byte`.
`byte`	`byteValueExact()` Returns this JSON number as a Java primitive `byte`.
`double`	`doubleValue()` Returns this JSON number as a Java primitive `double`, as-is.
`boolean`	`equals(Object otherObject)` Compares the specified object with this JSON number for equality.
`float`	`floatValue()` Returns this JSON number as a Java primitive `float`.
`JsonValue.EntityType`	`getEntityType()` Returns `JsonValue.EntityType.DOUBLE`, which is the entity type of `JsonDouble`.
`int`	`hashCode()` Returns the hash code value for this JSON number.
`int`	`intValue()` Returns this JSON number as a Java primitive `int`.
`int`	`intValueExact()` Returns this JSON number as a Java primitive `int`.
`boolean`	`isByteValue()` Returns `true` if the JSON number is integral in the range of `byte`, [-2⁷ to 2⁷-1].
`boolean`	`isIntegral()` Returns `true` if this JSON number is integral.
`boolean`	`isIntValue()` Returns `true` if the JSON number is integral in the range of `int`, [-2³¹ to 2³¹-1].
`boolean`	`isLongValue()` Returns `true` if the JSON number is integral in the range of `long`, [-2⁶³ to 2⁶³-1].
`boolean`	`isShortValue()` Returns `true` if the JSON number is integral in the range of `short`, [-2¹⁵ to 2¹⁵-1].
`long`	`longValue()` Returns this JSON number as a Java primitive `long`.
`long`	`longValueExact()` Returns this JSON number as a Java primitive `long`.
`static JsonDouble`	`of(double value)` Returns a JSON number represented by the specified Java primitive `double`.
`int`	`presumeReferenceSizeInBytes()` Returns `8` for the size of `double` in bytes presumed to occupy in `Page` as a reference.
`short`	`shortValue()` Returns this JSON number as a Java primitive `short`.
`short`	`shortValueExact()` Returns this JSON number as a Java primitive `short`.
`String`	`toJson()` Returns the stringified JSON representation of this JSON number.
`Value`	`toMsgpack()` Deprecated. Do not use this method. It is to be removed at some point after Embulk v1.0.0. It is here only to ensure a migration period from MessagePack-based JSON values to new JSON values of `JsonValue`.
`String`	`toString()` Returns the string representation of this JSON number.
`static JsonDouble`	`withLiteral(double value, String literal)` Returns a JSON number that is represented by the specified Java primitive `double`, with the specified JSON literal.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.embulk.spi.json.JsonValue
asJsonArray, asJsonBoolean, asJsonLong, asJsonNull, asJsonObject, asJsonString, fromMsgpack, isJsonArray, isJsonBoolean, isJsonDouble, isJsonLong, isJsonNull, isJsonObject, isJsonString

- Method Detail
  - of
```
public static JsonDouble of(double value)
```
    Returns a JSON number represented by the specified Java primitive double.
    
    Parameters:
    
    value - the number
    
    Returns:
    
    a JSON number represented by the specified Java primitive double
    
    Throws:
    
    ArithmeticException - if the specified number is NaN (Not-a-Number) or infinite
    
    Since:
    
    0.10.42
  - withLiteral
```
public static JsonDouble withLiteral(double value,
                                     String literal)
```
    Returns a JSON number that is represented by the specified Java primitive double, with the specified JSON literal.
    The literal is just subsidiary information used when stringifying this JSON number as JSON by toJson().
    
    Parameters:
    
    value - the number
    
    literal - the JSON literal of the number
    
    Returns:
    
    a JSON number represented by the specified Java primitive double
    
    Throws:
    
    ArithmeticException - if the specified number is NaN (Not-a-Number) or infinite
    
    Since:
    
    0.10.42
  - getEntityType
```
public JsonValue.EntityType getEntityType()
```
    Returns JsonValue.EntityType.DOUBLE, which is the entity type of JsonDouble.
    
    Specified by:
    
    getEntityType in interface JsonValue
    
    Returns:
    
    JsonValue.EntityType.DOUBLE, which is the entity type of JsonDouble
    
    Since:
    
    0.10.42
  - asJsonDouble
```
public JsonDouble asJsonDouble()
```
    Returns this value as JsonDouble.
    
    Specified by:
    
    asJsonDouble in interface JsonValue
    
    Returns:
    
    itself as JsonDouble
    
    Since:
    
    0.10.42
  - presumeReferenceSizeInBytes
```
public int presumeReferenceSizeInBytes()
```
    Returns 8 for the size of double in bytes presumed to occupy in Page as a reference.
    This approximate size is used only as a threshold whether PageBuilder is flushed, or not. It is not accurate, it does not need to be accurate, and it is impossible in general to tell an accurate size that a Java object occupies in the Java heap. But, a reasonable approximate would help to keep Page performant in the Java heap.
    It is better to flush more frequently for bigger JSON value objects, less often for smaller JSON value objects, but no infinite accumulation even for empty JSON value objects.
    
    Specified by:
    
    presumeReferenceSizeInBytes in interface JsonValue
    
    Returns:
    
    8
    
    See Also:
    
    "org.embulk.spi.PageBuilderImpl#addRecord", SIZE_OF_DOUBLE in Airlift's Slice
  - isIntegral
```
public boolean isIntegral()
```
    Returns true if this JSON number is integral.
    Note that it does not guarantee this JSON number can be represented as a Java primitive exact long. This JSON number can be out of the range of the Java primitive long.
    
    Specified by:
    
    isIntegral in interface JsonNumber
    
    Returns:
    
    true if this JSON number is integral
    
    Since:
    
    0.10.42
  - isByteValue
```
public boolean isByteValue()
```
    Returns true if the JSON number is integral in the range of byte, [-2⁷ to 2⁷-1].
    
    Specified by:
    
    isByteValue in interface JsonNumber
    
    Returns:
    
    true if the JSON number is integral in the range of byte
    
    Since:
    
    0.10.42
  - isShortValue
```
public boolean isShortValue()
```
    Returns true if the JSON number is integral in the range of short, [-2¹⁵ to 2¹⁵-1].
    
    Specified by:
    
    isShortValue in interface JsonNumber
    
    Returns:
    
    true if the JSON number is integral in the range of short
    
    Since:
    
    0.10.42
  - isIntValue
```
public boolean isIntValue()
```
    Returns true if the JSON number is integral in the range of int, [-2³¹ to 2³¹-1].
    
    Specified by:
    
    isIntValue in interface JsonNumber
    
    Returns:
    
    true if the JSON number is integral in the range of int
    
    Since:
    
    0.10.42
  - isLongValue
```
public boolean isLongValue()
```
    Returns true if the JSON number is integral in the range of long, [-2⁶³ to 2⁶³-1].
    
    Specified by:
    
    isLongValue in interface JsonNumber
    
    Returns:
    
    true if the JSON number is integral in the range of long
    
    Since:
    
    0.10.42
  - byteValue
```
public byte byteValue()
```
    Returns this JSON number as a Java primitive byte.
    It narrows down double to byte as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON number, precision, and range.
    
    Specified by:
    
    byteValue in interface JsonNumber
    
    Returns:
    
    the byte representation of this JSON number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - byteValueExact
```
public byte byteValueExact()
```
    Returns this JSON number as a Java primitive byte.
    It throws ArithmeticException if the JSON number is out of the range of byte, or has a non-zero fractional part.
    
    Specified by:
    
    byteValueExact in interface JsonNumber
    
    Returns:
    
    the byte representation of this JSON number
    
    Throws:
    
    ArithmeticException - if the JSON number is out of the range of byte, or has a non-zero fractional part
    
    Since:
    
    0.10.42
  - shortValue
```
public short shortValue()
```
    Returns this JSON number as a Java primitive short.
    It narrows down double to short as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON number, precision, and range.
    
    Specified by:
    
    shortValue in interface JsonNumber
    
    Returns:
    
    the short representation of this JSON number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - shortValueExact
```
public short shortValueExact()
```
    Returns this JSON number as a Java primitive short.
    It throws ArithmeticException if the JSON number is out of the range of short, or has a non-zero fractional part.
    
    Specified by:
    
    shortValueExact in interface JsonNumber
    
    Returns:
    
    the short representation of this JSON number
    
    Throws:
    
    ArithmeticException - if the JSON number is out of the range of short, or has a non-zero fractional part
    
    Since:
    
    0.10.42
  - intValue
```
public int intValue()
```
    Returns this JSON number as a Java primitive int.
    It narrows down double to int as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON number, precision, and range.
    
    Specified by:
    
    intValue in interface JsonNumber
    
    Returns:
    
    the int representation of this JSON number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - intValueExact
```
public int intValueExact()
```
    Returns this JSON number as a Java primitive int.
    It throws ArithmeticException if the JSON number is out of the range of int, or has a non-zero fractional part.
    
    Specified by:
    
    intValueExact in interface JsonNumber
    
    Returns:
    
    the int representation of this JSON number
    
    Throws:
    
    ArithmeticException - if the JSON number is out of the range of int, or has a non-zero fractional part
    
    Since:
    
    0.10.42
  - longValue
```
public long longValue()
```
    Returns this JSON number as a Java primitive long.
    It narrows down double to long as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON number, precision, and range.
    
    Specified by:
    
    longValue in interface JsonNumber
    
    Returns:
    
    the long representation of this JSON number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - longValueExact
```
public long longValueExact()
```
    Returns this JSON number as a Java primitive long.
    It throws ArithmeticException if the JSON number is out of the range of long, or has a non-zero fractional part.
    
    Specified by:
    
    longValueExact in interface JsonNumber
    
    Returns:
    
    the long representation of this JSON number
    
    Throws:
    
    ArithmeticException - if the JSON number is out of the range of long, or has a non-zero fractional part
    
    Since:
    
    0.10.42
  - bigIntegerValue
```
public BigInteger bigIntegerValue()
```
    Returns this JSON number as a BigInteger.
    Note that this conversion loses the fractional part and the precision of the number. This is a convenience method for bigDecimalValue().toBigInteger().
    
    Specified by:
    
    bigIntegerValue in interface JsonNumber
    
    Returns:
    
    the BigInteger representation of this JSON number
    
    Since:
    
    0.10.42
  - bigIntegerValueExact
```
public BigInteger bigIntegerValueExact()
```
    Returns this JSON number as a BigInteger.
    It throws ArithmeticException if the JSON number has a non-zero fractional part.
    
    Specified by:
    
    bigIntegerValueExact in interface JsonNumber
    
    Returns:
    
    the BigInteger representation of this JSON number
    
    Throws:
    
    ArithmeticException - if the JSON number has a non-zero fractional part
    
    Since:
    
    0.10.42
  - floatValue
```
public float floatValue()
```
    Returns this JSON number as a Java primitive float.
    It narrows down double to float as a Java primitive. Note that this conversion can lose information about the magnitude and the precision of the number.
    
    Specified by:
    
    floatValue in interface JsonNumber
    
    Returns:
    
    the float representation of this JSON number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Na rrowing Primitive Conversion
  - doubleValue
```
public double doubleValue()
```
    Returns this JSON number as a Java primitive double, as-is.
    This method does not lose any information because JsonDouble represents the number as a Java primitive double inside.
    
    Specified by:
    
    doubleValue in interface JsonNumber
    
    Returns:
    
    the double representation of this JSON number
    
    See Also:
    
    Java Language Specification - 5.1.3. Na rrowing Primitive Conversion
  - bigDecimalValue
```
public BigDecimal bigDecimalValue()
```
    Returns this JSON number as BigDecimal.
    
    Specified by:
    
    bigDecimalValue in interface JsonNumber
    
    Returns:
    
    the BigDecimal representation of this JSON number
  - toJson
```
public String toJson()
```
    Returns the stringified JSON representation of this JSON number.
    If this JSON number is created with a literal by withLiteral(double, String), it returns the literal.
    
    Specified by:
    
    toJson in interface JsonValue
    
    Returns:
    
    the stringified JSON representation of this JSON number
    
    Since:
    
    0.10.42
  - toMsgpack
```
@Deprecated
public Value toMsgpack()
```
    Deprecated. Do not use this method. It is to be removed at some point after Embulk v1.0.0. It is here only to ensure a migration period from MessagePack-based JSON values to new JSON values of JsonValue.
    
    Returns the corresponding MessagePack's Float value of this JSON number.
    
    Specified by:
    
    toMsgpack in interface JsonValue
    
    Returns:
    
    the corresponding MessagePack's Float value of this JSON number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Draft EEP: JSON Column Type
  - toString
```
public String toString()
```
    Returns the string representation of this JSON number.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this JSON number
    
    Since:
    
    0.10.42
  - equals
```
public boolean equals(Object otherObject)
```
    Compares the specified object with this JSON number for equality.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the specified object is equal to this JSON number
    
    Since:
    
    0.10.42
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this JSON number.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this JSON number
    
    Since:
    
    0.10.42

Class JsonDouble

Nested Class Summary

Nested classes/interfaces inherited from interface org.embulk.spi.json.JsonValue

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.embulk.spi.json.JsonValue

Method Detail

of

withLiteral

getEntityType

asJsonDouble

presumeReferenceSizeInBytes

isIntegral

isByteValue

isShortValue

isIntValue

isLongValue

byteValue

byteValueExact

shortValue

shortValueExact

intValue

intValueExact

longValue

longValueExact

bigIntegerValue

bigIntegerValueExact

floatValue

doubleValue

bigDecimalValue

toJson

toMsgpack

toString

equals

hashCode