JsonValue (embulk-spi 0.11 API)

All Known Subinterfaces:

JsonNumber

All Known Implementing Classes:

JsonArray, JsonBoolean, JsonDouble, JsonLong, JsonNull, JsonObject, JsonString
```
public interface JsonValue
```
Represents a value in JSON: null, true, false, numbers, strings, arrays, or objects.
Every implementation class of this interface should be final. It means that developers must not extend the existing JsonValue implementation classes by themselves.
Each implementation class of this interface should correspond to each JsonValue.EntityType constant by 1:1. For example, only JsonLong should be corresponding to JsonValue.EntityType.LONG, only JsonDouble should be corresponding to JsonValue.EntityType.DOUBLE, and only JsonObject should be corresponding to JsonValue.EntityType.OBJECT.
On the other hand, developers should keep it in mind that the future Embulk may have some more JsonValue implementation classes. For example, another implementation of integers backed by BigInteger, and another implementation of decimals backed by BigDecimal are under consideration. When it happens, new implementation classes like JsonBigInteger and JsonBigDecimal, and new entity types like EntityType#BIG_INTEGER and EntityType#BIG_DECIMAL would be added.

Since:

0.10.42

See Also:

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`JsonValue.EntityType` A type of a JSON value entity, which should correspond to the implementation class of the JSON value instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default JsonArray`	`asJsonArray()` Returns this value as `JsonArray`, or throws `ClassCastException` otherwise.
`default JsonBoolean`	`asJsonBoolean()` Returns this value as `JsonBoolean`, or throws `ClassCastException` otherwise.
`default JsonDouble`	`asJsonDouble()` Returns this value as `JsonDouble`, or throws `ClassCastException` otherwise.
`default JsonLong`	`asJsonLong()` Returns this value as `JsonLong`, or throws `ClassCastException` otherwise.
`default JsonNull`	`asJsonNull()` Returns this value as `JsonNull`, or throws `ClassCastException` otherwise.
`default JsonObject`	`asJsonObject()` Returns this value as `JsonObject`, or throws `ClassCastException` otherwise.
`default JsonString`	`asJsonString()` Returns this value as `JsonString`, or throws `ClassCastException` otherwise.
`static JsonValue`	`fromMsgpack(Value msgpackValue)` 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`.
`JsonValue.EntityType`	`getEntityType()` Returns the entity type of this JSON value.
`default boolean`	`isJsonArray()` Returns `true` if this JSON value is an array, which is `JsonArray`.
`default boolean`	`isJsonBoolean()` Returns `true` if this JSON value is `true` or `false`, which is `JsonBoolean`.
`default boolean`	`isJsonDouble()` Returns `true` if this JSON value is a number, which is `JsonDouble`.
`default boolean`	`isJsonLong()` Returns `true` if this JSON value is an integral number, which is `JsonLong`.
`default boolean`	`isJsonNull()` Returns `true` if this JSON value is `null`, which is `JsonNull`.
`default boolean`	`isJsonObject()` Returns `true` if this JSON value is an object, which is `JsonObject`.
`default boolean`	`isJsonString()` Returns `true` if this JSON value is a string, which is `JsonString`.
`int`	`presumeReferenceSizeInBytes()` Returns the approximate size of this JSON value in bytes presumed to occupy in `Page` as a reference.
`String`	`toJson()` Returns the stringified JSON representation of this JSON value.
`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`.

- Method Detail
  - getEntityType
```
JsonValue.EntityType getEntityType()
```
    Returns the entity type of this JSON value.
    
    Returns:
    
    the entity type of this JSON value
    
    Since:
    
    0.10.42
  - isJsonNull
```
default boolean isJsonNull()
```
    Returns true if this JSON value is null, which is JsonNull.
    If this method returns true, asJsonNull() never throws exceptions.
    
    Returns:
    
    true if this JSON value is null, which is JsonNull
    
    Since:
    
    0.10.42
  - isJsonBoolean
```
default boolean isJsonBoolean()
```
    Returns true if this JSON value is true or false, which is JsonBoolean.
    If this method returns true, asJsonBoolean() never throws exceptions.
    
    Returns:
    
    true if this JSON value is true or false, which is JsonBoolean
    
    Since:
    
    0.10.42
  - isJsonLong
```
default boolean isJsonLong()
```
    Returns true if this JSON value is an integral number, which is JsonLong.
    If this method returns true, asJsonLong() never throws exceptions.
    
    Returns:
    
    true if this JSON value is an integral number, which is JsonLong
    
    Since:
    
    0.10.42
  - isJsonDouble
```
default boolean isJsonDouble()
```
    Returns true if this JSON value is a number, which is JsonDouble.
    If this method returns true, asJsonDouble() never throws exceptions.
    
    Returns:
    
    true if this JSON value is a number, which is JsonDouble
    
    Since:
    
    0.10.42
  - isJsonString
```
default boolean isJsonString()
```
    Returns true if this JSON value is a string, which is JsonString. If this method returns true, asJsonString() never throws exceptions.
    
    Returns:
    
    true if this JSON value is a string, which is JsonString
    
    Since:
    
    0.10.42
  - isJsonArray
```
default boolean isJsonArray()
```
    Returns true if this JSON value is an array, which is JsonArray.
    If this method returns true, asJsonArray() never throws exceptions.
    
    Returns:
    
    true if this JSON value is an array, which is JsonArray
    
    Since:
    
    0.10.42
  - isJsonObject
```
default boolean isJsonObject()
```
    Returns true if this JSON value is an object, which is JsonObject.
    If this method returns true, asJsonObject() never throws exceptions.
    
    Returns:
    
    true if this JSON value is an object, which is JsonObject
    
    Since:
    
    0.10.42
  - asJsonNull
```
default JsonNull asJsonNull()
```
    Returns this value as JsonNull, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonNull
    
    Throws:
    
    ClassCastException - if this JSON value is not null, not JsonNull
    
    Since:
    
    0.10.42
  - asJsonBoolean
```
default JsonBoolean asJsonBoolean()
```
    Returns this value as JsonBoolean, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonBoolean
    
    Throws:
    
    ClassCastException - if this JSON value is not true nor false, not JsonBoolean
    
    Since:
    
    0.10.42
  - asJsonLong
```
default JsonLong asJsonLong()
```
    Returns this value as JsonLong, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonLong
    
    Throws:
    
    ClassCastException - if this JSON value is not an integral number, not JsonLong
    
    Since:
    
    0.10.42
  - asJsonDouble
```
default JsonDouble asJsonDouble()
```
    Returns this value as JsonDouble, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonDouble
    
    Throws:
    
    ClassCastException - if this JSON value is not a number, not JsonDouble
    
    Since:
    
    0.10.42
  - asJsonString
```
default JsonString asJsonString()
```
    Returns this value as JsonString, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonString
    
    Throws:
    
    ClassCastException - if this JSON value is not a string, not JsonString
    
    Since:
    
    0.10.42
  - asJsonArray
```
default JsonArray asJsonArray()
```
    Returns this value as JsonArray, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonArray
    
    Throws:
    
    ClassCastException - if this JSON value is not an array, not JsonArray
    
    Since:
    
    0.10.42
  - asJsonObject
```
default JsonObject asJsonObject()
```
    Returns this value as JsonObject, or throws ClassCastException otherwise.
    
    Returns:
    
    itself as JsonObject
    
    Throws:
    
    ClassCastException - if this JSON value is not an object, not JsonObject
    
    Since:
    
    0.10.42
  - presumeReferenceSizeInBytes
```
int presumeReferenceSizeInBytes()
```
    Returns the approximate size of this JSON value 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.
    
    Returns:
    
    the approximate size of this JSON value in bytes presumed to occupy in Page as a reference
    
    See Also:
    
    "org.embulk.spi.PageBuilderImpl#addRecord"
  - toJson
```
String toJson()
```
    Returns the stringified JSON representation of this JSON value.
    NaN and Infinity of JsonDouble are converted to "null".
    
    Returns:
    
    the stringified JSON representation of this JSON value
    
    Since:
    
    0.10.42
  - toMsgpack
```
@Deprecated
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 value object of this JSON value.
    
    Returns:
    
    the corresponding MessagePack's value object of this JSON value
    
    Since:
    
    0.10.42
    
    See Also:
    
    Draft EEP: JSON Column Type
  - fromMsgpack
```
@Deprecated
static JsonValue fromMsgpack(Value msgpackValue)
```
    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 a new JSON value based on the specified MessagePack's value.
    
    Parameters:
    
    msgpackValue - the MessagePack's value
    
    Returns:
    
    the new JSON value
    
    Since:
    
    0.10.42
    
    See Also:
    
    Draft EEP: JSON Column Type

Interface JsonValue

Nested Class Summary

Method Summary

Method Detail

getEntityType

isJsonNull

isJsonBoolean

isJsonLong

isJsonDouble

isJsonString

isJsonArray

isJsonObject

asJsonNull

asJsonBoolean

asJsonLong

asJsonDouble

asJsonString

asJsonArray

asJsonObject

presumeReferenceSizeInBytes

toJson

toMsgpack

fromMsgpack