org.embulk.spi.json

Class JsonObject

java.lang.Object

java.util.AbstractMap<String,JsonValue>

org.embulk.spi.json.JsonObject

All Implemented Interfaces:

Map<String,JsonValue>, JsonValue

public final class JsonObject
extends AbstractMap<String,JsonValue>
implements JsonValue

Represents an object in JSON.

Since:

0.10.42

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonObject.Builder Builds instances of JsonObject from keys and values configured by put* methods.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

JsonValue.EntityType

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
JsonObject	asJsonObject() Returns this value as JsonObject.
static JsonObject.Builder	builder() Returns a JsonObject.Builder.
static Map.Entry<JsonString,JsonValue>	entry(JsonString key, JsonValue value) Returns a Map.Entry of a JsonString key and a JsonValue value.
static Map.Entry<String,JsonValue>	entry(String key, JsonValue value) Returns a Map.Entry of a String key and a JsonValue value.
Set<Map.Entry<String,JsonValue>>	entrySet() Returns a Set view of the JSON key-value mappings contained in this JSON object.
boolean	equals(Object otherObject) Compares the specified object with this JSON object for equality.
JsonValue.EntityType	getEntityType() Returns JsonValue.EntityType.OBJECT, which is the entity type of JsonObject.
JsonValue[]	getKeyValueArray() Returns the key-value pairs as an array of JsonValue.
int	hashCode() Returns the hash code value for this JSON object.
static JsonObject	of() Returns a JSON object containing zero JSON key-value mapping.
static JsonObject	of(JsonValue... keyValues) Returns a JSON object containing an arbitrary number of JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1) Returns a JSON object containing the specified single JSON key-value mapping.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2) Returns a JSON object containing the specified two JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3) Returns a JSON object containing the specified three JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4) Returns a JSON object containing the specified four JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4, String k5, JsonValue v5) Returns a JSON object containing the specified five JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4, String k5, JsonValue v5, String k6, JsonValue v6) Returns a JSON object containing the specified six JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4, String k5, JsonValue v5, String k6, JsonValue v6, String k7, JsonValue v7) Returns a JSON object containing the specified seven JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4, String k5, JsonValue v5, String k6, JsonValue v6, String k7, JsonValue v7, String k8, JsonValue v8) Returns a JSON object containing the specified eight JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4, String k5, JsonValue v5, String k6, JsonValue v6, String k7, JsonValue v7, String k8, JsonValue v8, String k9, JsonValue v9) Returns a JSON object containing the specified nine JSON key-value mappings.
static JsonObject	of(String k1, JsonValue v1, String k2, JsonValue v2, String k3, JsonValue v3, String k4, JsonValue v4, String k5, JsonValue v5, String k6, JsonValue v6, String k7, JsonValue v7, String k8, JsonValue v8, String k9, JsonValue v9, String k10, JsonValue v10) Returns a JSON object containing the specified ten JSON key-value mappings.
static JsonObject	ofEntries(Map.Entry<String,JsonValue>... entries) Returns a JSON object containing keys and values extracted from the given entries.
static JsonObject	ofEntriesWithJsonStringKeys(Map.Entry<JsonString,JsonValue>... entries) Returns a JSON object containing keys and values extracted from the given entries.
static JsonObject	ofMap(Map<String,JsonValue> map) Returns a JSON object containing keys and values extracted from the given Map.
static JsonObject	ofMapWithJsonStringKeys(Map<JsonString,JsonValue> map) Returns a JSON object containing keys and values extracted from the given Map.
static JsonObject	ofUnsafe(String[] keys, JsonValue[] values) Returns a JSON object containing the specified arrays as its internal representation.
int	presumeReferenceSizeInBytes() Returns the approximate size of this JSON object in bytes presumed to occupy in Page as a reference.
int	size() Returns the number of JSON key-value mappings in this object.
String	toJson() Returns the stringified JSON representation of this JSON object.
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 object.

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, get, isEmpty, keySet, put, putAll, remove, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

asJsonArray, asJsonBoolean, asJsonDouble, asJsonLong, asJsonNull, asJsonString, fromMsgpack, isJsonArray, isJsonBoolean, isJsonDouble, isJsonLong, isJsonNull, isJsonObject, isJsonString

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

of

public static JsonObject of()

Returns a JSON object containing zero JSON key-value mapping.

Returns:

an empty JSON object

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1)

Returns a JSON object containing the specified single JSON key-value mapping.

Parameters:

k1 - the mapping's key, not null

v1 - the mapping's value, not null

Returns:

a JSON object containing the specified mapping

Throws:

NullPointerException - if the key or the value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2)

Returns a JSON object containing the specified two JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3)

Returns a JSON object containing the specified three JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4)

Returns a JSON object containing the specified four JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4,
                            String k5,
                            JsonValue v5)

Returns a JSON object containing the specified five JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

k5 - the fifth mapping's key, not null

v5 - the fifth mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4,
                            String k5,
                            JsonValue v5,
                            String k6,
                            JsonValue v6)

Returns a JSON object containing the specified six JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

k5 - the fifth mapping's key, not null

v5 - the fifth mapping's value, not null

k6 - the sixth mapping's key, not null

v6 - the sixth mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4,
                            String k5,
                            JsonValue v5,
                            String k6,
                            JsonValue v6,
                            String k7,
                            JsonValue v7)

Returns a JSON object containing the specified seven JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

k5 - the fifth mapping's key, not null

v5 - the fifth mapping's value, not null

k6 - the sixth mapping's key, not null

v6 - the sixth mapping's value, not null

k7 - the seventh mapping's key, not null

v7 - the seventh mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4,
                            String k5,
                            JsonValue v5,
                            String k6,
                            JsonValue v6,
                            String k7,
                            JsonValue v7,
                            String k8,
                            JsonValue v8)

Returns a JSON object containing the specified eight JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

k5 - the fifth mapping's key, not null

v5 - the fifth mapping's value, not null

k6 - the sixth mapping's key, not null

v6 - the sixth mapping's value, not null

k7 - the seventh mapping's key, not null

v7 - the seventh mapping's value, not null

k8 - the eighth mapping's key, not null

v8 - the eighth mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4,
                            String k5,
                            JsonValue v5,
                            String k6,
                            JsonValue v6,
                            String k7,
                            JsonValue v7,
                            String k8,
                            JsonValue v8,
                            String k9,
                            JsonValue v9)

Returns a JSON object containing the specified nine JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

k5 - the fifth mapping's key, not null

v5 - the fifth mapping's value, not null

k6 - the sixth mapping's key, not null

v6 - the sixth mapping's value, not null

k7 - the seventh mapping's key, not null

v7 - the seventh mapping's value, not null

k8 - the eighth mapping's key, not null

v8 - the eighth mapping's value, not null

k9 - the ninth mapping's key, not null

v9 - the ninth mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(String k1,
                            JsonValue v1,
                            String k2,
                            JsonValue v2,
                            String k3,
                            JsonValue v3,
                            String k4,
                            JsonValue v4,
                            String k5,
                            JsonValue v5,
                            String k6,
                            JsonValue v6,
                            String k7,
                            JsonValue v7,
                            String k8,
                            JsonValue v8,
                            String k9,
                            JsonValue v9,
                            String k10,
                            JsonValue v10)

Returns a JSON object containing the specified ten JSON key-value mappings.

Parameters:

k1 - the first mapping's key, not null

v1 - the first mapping's value, not null

k2 - the second mapping's key, not null

v2 - the second mapping's value, not null

k3 - the third mapping's key, not null

v3 - the third mapping's value, not null

k4 - the fourth mapping's key, not null

v4 - the fourth mapping's value, not null

k5 - the fifth mapping's key, not null

v5 - the fifth mapping's value, not null

k6 - the sixth mapping's key, not null

v6 - the sixth mapping's value, not null

k7 - the seventh mapping's key, not null

v7 - the seventh mapping's value, not null

k8 - the eighth mapping's key, not null

v8 - the eighth mapping's value, not null

k9 - the ninth mapping's key, not null

v9 - the ninth mapping's value, not null

k10 - the tenth mapping's key, not null

v10 - the tenth mapping's value, not null

Returns:

a JSON object containing the specified mappings

Throws:

NullPointerException - if any key or any value is null

Since:

0.10.42

of

public static JsonObject of(JsonValue... keyValues)

Returns a JSON object containing an arbitrary number of JSON key-value mappings.

Keys and values are specified as varargs. Even numbers of arguments must be specified. Where i as an odd number, the i-th argument represents a key that must be JsonString, and the i+1-th argument represents a value for the key at the i-th argument.

Parameters:

keyValues - the JSON keys and values to be contained in the JSON object, not null

Returns:

a JSON object containing the specified JSON key-value mappings

Throws:

IllegalArgumentException - if odd numbers of arguments are specified, or non-JsonString is specified as key

NullPointerException - if any key or any value is null

Since:

0.10.42

ofEntries

@SafeVarargs
public static JsonObject ofEntries(Map.Entry<String,JsonValue>... entries)

Returns a JSON object containing keys and values extracted from the given entries.

The specified entries themselves are not stored in the JSON object.

Parameters:

entries - Map.Entrys containing String keys and JsonValue values from which the JSON object is populated, not null

Returns:

a JSON object containing the specified JSON key-value mappings

Throws:

NullPointerException - if the entries, any key or any value is null

Since:

0.10.42

ofEntriesWithJsonStringKeys

@SafeVarargs
public static JsonObject ofEntriesWithJsonStringKeys(Map.Entry<JsonString,JsonValue>... entries)

Returns a JSON object containing keys and values extracted from the given entries.

The specified entries themselves are not stored in the JSON object.

Parameters:

entries - Map.Entrys containing JsonString keys and JsonValue values from which the JSON object is populated, not null

Returns:

a JSON object containing the specified JSON key-value mappings

Throws:

NullPointerException - if the entries, any key or any value is null

Since:

0.10.42

ofMap

public static JsonObject ofMap(Map<String,JsonValue> map)

Returns a JSON object containing keys and values extracted from the given Map.

The specified map itself is not stored in the JSON object.

Parameters:

map - a Map containing String keys and JsonValue values from which the JSON object is populated, not null

Returns:

a JSON object containing the specified JSON key-value mappings

Throws:

NullPointerException - if the map, any key or any value is null

Since:

0.10.42

ofMapWithJsonStringKeys

public static JsonObject ofMapWithJsonStringKeys(Map<JsonString,JsonValue> map)

Returns a JSON object containing keys and values extracted from the given Map.

The specified map itself is not stored in the JSON object.

Parameters:

map - a Map containing JsonString keys and JsonValue values from which the JSON object is populated, not null

Returns:

a JSON object containing the specified JSON key-value mappings

Throws:

NullPointerException - if the map, any key or any value is null

Since:

0.10.42

ofUnsafe

public static JsonObject ofUnsafe(String[] keys,
                                  JsonValue[] values)

Returns a JSON object containing the specified arrays as its internal representation.

This method is not safe. If the specified array is modified after creating a JsonObject instance with this method, the created JsonObject instance can unintentionally behave differently.

It has no null checks. If either of the specified arrays is null, or contains null, the created JsonObject can behave unexpectedly.

Parameters:

keys - the array of strings to be the internal representation as the keys in the new JsonObject

values - the array of JSON values to be the internal representation as the values in the new JsonObject

Returns:

a JSON object containing the specified array as the internal representation

Since:

0.10.42

builder

public static JsonObject.Builder builder()

Returns a JsonObject.Builder.

Returns:

a JsonObject.Builder

Since:

0.10.42

entry

public static Map.Entry<String,JsonValue> entry(String key,
                                                JsonValue value)

Returns a Map.Entry of a String key and a JsonValue value.

Parameters:

key - the key

value - the value

Returns:

a Map.Entry

Since:

0.10.42

entry

public static Map.Entry<JsonString,JsonValue> entry(JsonString key,
                                                    JsonValue value)

Returns a Map.Entry of a JsonString key and a JsonValue value.

Parameters:

key - the key

value - the value

Returns:

a Map.Entry

Since:

0.10.42

getEntityType

public JsonValue.EntityType getEntityType()

Returns JsonValue.EntityType.OBJECT, which is the entity type of JsonObject.

Specified by:

getEntityType in interface JsonValue

Returns:

JsonValue.EntityType.OBJECT, which is the entity type of JsonObject

Since:

0.10.42

asJsonObject

public JsonObject asJsonObject()

Returns this value as JsonObject.

Specified by:

asJsonObject in interface JsonValue

Returns:

itself as JsonObject

Since:

0.10.42

presumeReferenceSizeInBytes

public int presumeReferenceSizeInBytes()

Returns the approximate size of this JSON object 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:

the approximate size of this JSON object in bytes presumed to occupy in Page as a reference

See Also:

"org.embulk.spi.PageBuilderImpl#addRecord"

size

public int size()

Returns the number of JSON key-value mappings in this object.

Specified by:

size in interface Map<String,JsonValue>

Overrides:

size in class AbstractMap<String,JsonValue>

Returns:

the number of JSON key-value mappings in this object

Since:

0.10.42

entrySet

public Set<Map.Entry<String,JsonValue>> entrySet()

Returns a Set view of the JSON key-value mappings contained in this JSON object.

This JSON object is unmodifiable, then the set is unmodifiable, too.

Specified by:

entrySet in interface Map<String,JsonValue>

Specified by:

entrySet in class AbstractMap<String,JsonValue>

Returns:

a Set view of the JSON value key-mappings contained in this JSON object

Since:

0.10.42

getKeyValueArray

public JsonValue[] getKeyValueArray()

Returns the key-value pairs as an array of JsonValue. Odd elements are keys. Next element of an odd element is a value corresponding to the key. For example, if this value represents {"k1": "v1", "k2": "v2"}, this method returns ["k1", "v1", "k2", "v2"].

toJson

public String toJson()

Returns the stringified JSON representation of this JSON object.

Specified by:

toJson in interface JsonValue

Returns:

the stringified JSON representation of this JSON object

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 Map value of this JSON string.

Specified by:

toMsgpack in interface JsonValue

Returns:

the corresponding MessagePack's Map value of this JSON string

Since:

0.10.42

See Also:

Draft EEP: JSON Column Type

toString

public String toString()

Returns the string representation of this JSON object.

Overrides:

toString in class AbstractMap<String,JsonValue>

Returns:

the string representation of this JSON object

Since:

0.10.42

equals

public boolean equals(Object otherObject)

Compares the specified object with this JSON object for equality.

Note that it can return true only when JsonObject is given. It checks the equality as a JSON object. It does not return true for a general Map even though the given map contains the same mapping.

Specified by:

equals in interface Map<String,JsonValue>

Overrides:

equals in class AbstractMap<String,JsonValue>

Returns:

true if the specified object is equal to this JSON object

Since:

0.10.42

hashCode

public int hashCode()

Returns the hash code value for this JSON object.

Specified by:

hashCode in interface Map<String,JsonValue>

Overrides:

hashCode in class AbstractMap<String,JsonValue>

Returns:

the hash code value for this JSON object

Since:

0.10.42