JsonLong (embulk-spi 0.11 API)

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

All Implemented Interfaces:

JsonNumber, JsonValue
```
public final class JsonLong
extends Object
implements JsonNumber
```
Represents a integral number in JSON, represented by a Java primitive long, which is the same as Embulk's LONG column type.

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
`JsonLong`	`asJsonLong()` Returns this value as `JsonLong`.
`BigDecimal`	`bigDecimalValue()` Returns this JSON integral number as a `BigDecimal`.
`BigInteger`	`bigIntegerValue()` Returns this JSON integral number as a `BigInteger`.
`BigInteger`	`bigIntegerValueExact()` Returns this JSON integral number as a `BigInteger`.
`byte`	`byteValue()` Returns this JSON integral number as a Java primitive `byte`.
`byte`	`byteValueExact()` Returns this JSON integral number as a Java primitive `byte`.
`double`	`doubleValue()` Returns this JSON integral number as a Java primitive `double`.
`boolean`	`equals(Object otherObject)` Compares the specified object with this JSON integral number for equality.
`float`	`floatValue()` Returns this JSON integral number as a Java primitive `float`.
`JsonValue.EntityType`	`getEntityType()` Returns `JsonValue.EntityType.LONG`, which is the entity type of `JsonLong`.
`int`	`hashCode()` Returns the hash code value for this JSON integral number.
`int`	`intValue()` Returns this JSON integral number as a Java primitive `int`.
`int`	`intValueExact()` Returns this JSON integral number as a Java primitive `int`.
`boolean`	`isByteValue()` Returns `true` if the JSON integral number is in the range of `byte`, [-2⁷ to 2⁷-1].
`boolean`	`isIntegral()` Returns `true` to represent this JSON number is integral.
`boolean`	`isIntValue()` Returns `true` if the JSON integral number is in the range of `int`, [-2³¹ to 2³¹-1].
`boolean`	`isLongValue()` Returns `true`.
`boolean`	`isShortValue()` Returns `true` if the JSON integral number is in the range of `short`, [-2¹⁵ to 2¹⁵-1].
`long`	`longValue()` Returns this JSON integral number as a Java primitive `long`.
`long`	`longValueExact()` Returns this JSON integral number as a Java primitive `long`.
`static JsonLong`	`of(long value)` Returns a JSON integral number represented by the specified Java primitive `long`.
`int`	`presumeReferenceSizeInBytes()` Returns `8` for the size of `long` in bytes presumed to occupy in `Page` as a reference.
`short`	`shortValue()` Returns this JSON integral number as a Java primitive `short`.
`short`	`shortValueExact()` Returns this JSON integral number as a Java primitive `short`.
`String`	`toJson()` Returns the stringified JSON representation of this JSON integral 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 integral number.
`static JsonLong`	`withLiteral(long value, String literal)` Returns a JSON integral number represented by the specified Java primitive `long`, 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, asJsonDouble, asJsonNull, asJsonObject, asJsonString, fromMsgpack, isJsonArray, isJsonBoolean, isJsonDouble, isJsonLong, isJsonNull, isJsonObject, isJsonString

- Method Detail
  - of
```
public static JsonLong of(long value)
```
    Returns a JSON integral number represented by the specified Java primitive long.
    
    Parameters:
    
    value - the integral number
    
    Returns:
    
    a JSON integral number represented by the specified Java primitive long
    
    Since:
    
    0.10.42
  - withLiteral
```
public static JsonLong withLiteral(long value,
                                   String literal)
```
    Returns a JSON integral number represented by the specified Java primitive long, with the specified JSON literal.
    The literal is just subsidiary information used when stringifying this integral number as JSON by toJson(). The literal does not impact the equality definition by equals(Object).
    
    Parameters:
    
    value - the integral number
    
    literal - the JSON literal of the integral number
    
    Returns:
    
    a JSON integral number represented by the specified Java primitive long
    
    Since:
    
    0.10.42
  - getEntityType
```
public JsonValue.EntityType getEntityType()
```
    Returns JsonValue.EntityType.LONG, which is the entity type of JsonLong.
    
    Specified by:
    
    getEntityType in interface JsonValue
    
    Returns:
    
    JsonValue.EntityType.LONG, which is the entity type of JsonLong
    
    Since:
    
    0.10.42
  - asJsonLong
```
public JsonLong asJsonLong()
```
    Returns this value as JsonLong.
    
    Specified by:
    
    asJsonLong in interface JsonValue
    
    Returns:
    
    itself as JsonLong
    
    Since:
    
    0.10.42
  - presumeReferenceSizeInBytes
```
public int presumeReferenceSizeInBytes()
```
    Returns 8 for the size of long 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_LONG in Airlift's Slice
  - isIntegral
```
public boolean isIntegral()
```
    Returns true to represent this JSON number is integral.
    
    Specified by:
    
    isIntegral in interface JsonNumber
    
    Returns:
    
    true
    
    Since:
    
    0.10.42
  - isByteValue
```
public boolean isByteValue()
```
    Returns true if the JSON integral number is in the range of byte, [-2⁷ to 2⁷-1].
    
    Specified by:
    
    isByteValue in interface JsonNumber
    
    Returns:
    
    true if the JSON integral number is in the range of byte
    
    Since:
    
    0.10.42
  - isShortValue
```
public boolean isShortValue()
```
    Returns true if the JSON integral number is in the range of short, [-2¹⁵ to 2¹⁵-1].
    
    Specified by:
    
    isShortValue in interface JsonNumber
    
    Returns:
    
    true if the JSON integral number is in the range of short
    
    Since:
    
    0.10.42
  - isIntValue
```
public boolean isIntValue()
```
    Returns true if the JSON integral number is in the range of int, [-2³¹ to 2³¹-1].
    
    Specified by:
    
    isIntValue in interface JsonNumber
    
    Returns:
    
    true if the JSON integral number is in the range of int
    
    Since:
    
    0.10.42
  - isLongValue
```
public boolean isLongValue()
```
    Returns true.
    
    Specified by:
    
    isLongValue in interface JsonNumber
    
    Returns:
    
    true, always
    
    Since:
    
    0.10.42
  - byteValue
```
public byte byteValue()
```
    Returns this JSON integral number as a Java primitive byte.
    It narrows down long to byte as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON integral number, and can cause the sign of the resulting value to differ from the sign of this JSON integral number.
    
    Specified by:
    
    byteValue in interface JsonNumber
    
    Returns:
    
    the byte representation of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - byteValueExact
```
public byte byteValueExact()
```
    Returns this JSON integral number as a Java primitive byte.
    It throws ArithmeticException if the JSON integral number is out of the range of byte.
    
    Specified by:
    
    byteValueExact in interface JsonNumber
    
    Returns:
    
    the byte representation of this JSON integral number
    
    Throws:
    
    ArithmeticException - if the JSON integral number does not fit in a Java primitive byte
    
    Since:
    
    0.10.42
  - shortValue
```
public short shortValue()
```
    Returns this JSON integral number as a Java primitive short.
    It narrows down long to short as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON integral number, and can cause the sign of the resulting value to differ from the sign of this JSON integral number.
    
    Specified by:
    
    shortValue in interface JsonNumber
    
    Returns:
    
    the short representation of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - shortValueExact
```
public short shortValueExact()
```
    Returns this JSON integral number as a Java primitive short.
    It throws ArithmeticException if the JSON integral number is out of the range of short.
    
    Specified by:
    
    shortValueExact in interface JsonNumber
    
    Returns:
    
    the short representation of this JSON integral number
    
    Throws:
    
    ArithmeticException - if the JSON integral number does not fit in a Java primitive short
    
    Since:
    
    0.10.42
  - intValue
```
public int intValue()
```
    Returns this JSON integral number as a Java primitive int.
    It narrows down long to int as a Java primitive. Note that this conversion can lose information about the magnitude of this JSON integral number, and can cause the sign of the resulting value to differ from the sign of this JSON integral number.
    
    Specified by:
    
    intValue in interface JsonNumber
    
    Returns:
    
    the int representation of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - intValueExact
```
public int intValueExact()
```
    Returns this JSON integral number as a Java primitive int.
    It throws ArithmeticException if the JSON integral number is out of the range of int.
    
    Specified by:
    
    intValueExact in interface JsonNumber
    
    Returns:
    
    the int representation of this JSON integral number
    
    Throws:
    
    ArithmeticException - if the JSON integral number does not fit in a Java primitive int
    
    Since:
    
    0.10.42
  - longValue
```
public long longValue()
```
    Returns this JSON integral number as a Java primitive long.
    
    Specified by:
    
    longValue in interface JsonNumber
    
    Returns:
    
    the long representation of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.3. Narrowing Primitive Conversion
  - longValueExact
```
public long longValueExact()
```
    Returns this JSON integral number as a Java primitive long.
    
    Specified by:
    
    longValueExact in interface JsonNumber
    
    Returns:
    
    the long representation of this JSON integral number
    
    Since:
    
    0.10.42
  - bigIntegerValue
```
public BigInteger bigIntegerValue()
```
    Returns this JSON integral number as a BigInteger.
    
    Specified by:
    
    bigIntegerValue in interface JsonNumber
    
    Returns:
    
    the BigInteger representation of this JSON integral number
    
    Since:
    
    0.10.42
  - bigIntegerValueExact
```
public BigInteger bigIntegerValueExact()
```
    Returns this JSON integral number as a BigInteger.
    
    Specified by:
    
    bigIntegerValueExact in interface JsonNumber
    
    Returns:
    
    the BigInteger representation of this JSON integral number
    
    Since:
    
    0.10.42
  - floatValue
```
public float floatValue()
```
    Returns this JSON integral number as a Java primitive float.
    It widens long to float as a Java primitive. Note that this conversion can lose precision of this JSON integral number.
    
    Specified by:
    
    floatValue in interface JsonNumber
    
    Returns:
    
    the float representation of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.2. Widening Primitive Conversion
  - doubleValue
```
public double doubleValue()
```
    Returns this JSON integral number as a Java primitive double.
    It widens long to double as a Java primitive. Note that this conversion can lose precision of this JSON integral number.
    
    Specified by:
    
    doubleValue in interface JsonNumber
    
    Returns:
    
    the double representation of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Java Language Specification - 5.1.2. Widening Primitive Conversion
  - bigDecimalValue
```
public BigDecimal bigDecimalValue()
```
    Returns this JSON integral number as a BigDecimal.
    
    Specified by:
    
    bigDecimalValue in interface JsonNumber
    
    Returns:
    
    the BigDecimal representation of this JSON integral number
    
    Since:
    
    0.10.42
  - toJson
```
public String toJson()
```
    Returns the stringified JSON representation of this JSON integral number.
    If this JSON integral number is created with a literal by withLiteral(long, String), it returns the literal.
    
    Specified by:
    
    toJson in interface JsonValue
    
    Returns:
    
    the stringified JSON representation of this JSON integral 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 Integer value of this JSON integral number.
    
    Specified by:
    
    toMsgpack in interface JsonValue
    
    Returns:
    
    the corresponding MessagePack's Integer value of this JSON integral number
    
    Since:
    
    0.10.42
    
    See Also:
    
    Draft EEP: JSON Column Type
  - toString
```
public String toString()
```
    Returns the string representation of this JSON integral number.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation of this JSON integral number
    
    Since:
    
    0.10.42
  - equals
```
public boolean equals(Object otherObject)
```
    Compares the specified object with this JSON integral number for equality.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if the specified object is equal to this JSON integral number
    
    Since:
    
    0.10.42
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this JSON integral number.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hash code value for this JSON integral number
    
    Since:
    
    0.10.42

Class JsonLong

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

asJsonLong

presumeReferenceSizeInBytes

isIntegral

isByteValue

isShortValue

isIntValue

isLongValue

byteValue

byteValueExact

shortValue

shortValueExact

intValue

intValueExact

longValue

longValueExact

bigIntegerValue

bigIntegerValueExact

floatValue

doubleValue

bigDecimalValue

toJson

toMsgpack

toString

equals

hashCode