1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*
* Copyright 2017-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:OptIn(ExperimentalContracts::class)
package kotlinx.serialization.json
import kotlinx.serialization.ExperimentalSerializationApi
import kotlin.contracts.*
import kotlin.jvm.JvmName
/**
* Builds [JsonObject] with the given [builderAction] builder.
* Example of usage:
* ```
* val json = buildJsonObject {
* put("booleanKey", true)
* putJsonArray("arrayKey") {
* for (i in 1..10) add(i)
* }
* putJsonObject("objectKey") {
* put("stringKey", "stringValue")
* }
* }
* ```
*/
public inline fun buildJsonObject(builderAction: JsonObjectBuilder.() -> Unit): JsonObject {
contract { callsInPlace(builderAction, InvocationKind.EXACTLY_ONCE) }
val builder = JsonObjectBuilder()
builder.builderAction()
return builder.build()
}
/**
* Builds [JsonArray] with the given [builderAction] builder.
* Example of usage:
* ```
* val json = buildJsonArray {
* add(true)
* addJsonArray {
* for (i in 1..10) add(i)
* }
* addJsonObject {
* put("stringKey", "stringValue")
* }
* }
* ```
*/
public inline fun buildJsonArray(builderAction: JsonArrayBuilder.() -> Unit): JsonArray {
contract { callsInPlace(builderAction, InvocationKind.EXACTLY_ONCE) }
val builder = JsonArrayBuilder()
builder.builderAction()
return builder.build()
}
/**
* DSL builder for a [JsonObject]. To create an instance of builder, use [buildJsonObject] build function.
*/
@JsonDslMarker
public class JsonObjectBuilder @PublishedApi internal constructor() {
private val content: MutableMap<String, JsonElement> = linkedMapOf()
/**
* Add the given JSON [element] to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
public fun put(key: String, element: JsonElement): JsonElement? = content.put(key, element)
@PublishedApi
internal fun build(): JsonObject = JsonObject(content)
}
/**
* Add the [JSON object][JsonObject] produced by the [builderAction] function to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
public fun JsonObjectBuilder.putJsonObject(key: String, builderAction: JsonObjectBuilder.() -> Unit): JsonElement? =
put(key, buildJsonObject(builderAction))
/**
* Add the [JSON array][JsonArray] produced by the [builderAction] function to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
public fun JsonObjectBuilder.putJsonArray(key: String, builderAction: JsonArrayBuilder.() -> Unit): JsonElement? =
put(key, buildJsonArray(builderAction))
/**
* Add the given boolean [value] to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
public fun JsonObjectBuilder.put(key: String, value: Boolean?): JsonElement? = put(key, JsonPrimitive(value))
/**
* Add the given numeric [value] to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
public fun JsonObjectBuilder.put(key: String, value: Number?): JsonElement? = put(key, JsonPrimitive(value))
/**
* Add the given string [value] to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
public fun JsonObjectBuilder.put(key: String, value: String?): JsonElement? = put(key, JsonPrimitive(value))
/**
* Add `null` to a resulting JSON object using the given [key].
*
* Returns the previous value associated with [key], or `null` if the key was not present.
*/
@ExperimentalSerializationApi
@Suppress("UNUSED_PARAMETER") // allows to call `put("key", null)`
public fun JsonObjectBuilder.put(key: String, value: Nothing?): JsonElement? = put(key, JsonNull)
/**
* DSL builder for a [JsonArray]. To create an instance of builder, use [buildJsonArray] build function.
*/
@JsonDslMarker
public class JsonArrayBuilder @PublishedApi internal constructor() {
private val content: MutableList<JsonElement> = mutableListOf()
/**
* Adds the given JSON [element] to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
public fun add(element: JsonElement): Boolean {
content += element
return true
}
/**
* Adds the given JSON [elements] to a resulting JSON array.
*
* @return `true` if the list was changed as the result of the operation.
*/
@ExperimentalSerializationApi
public fun addAll(elements: Collection<JsonElement>): Boolean =
content.addAll(elements)
@PublishedApi
internal fun build(): JsonArray = JsonArray(content)
}
/**
* Adds the given boolean [value] to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
public fun JsonArrayBuilder.add(value: Boolean?): Boolean = add(JsonPrimitive(value))
/**
* Adds the given numeric [value] to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
public fun JsonArrayBuilder.add(value: Number?): Boolean = add(JsonPrimitive(value))
/**
* Adds the given string [value] to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
public fun JsonArrayBuilder.add(value: String?): Boolean = add(JsonPrimitive(value))
/**
* Adds `null` to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
@ExperimentalSerializationApi
@Suppress("UNUSED_PARAMETER") // allows to call `add(null)`
public fun JsonArrayBuilder.add(value: Nothing?): Boolean = add(JsonNull)
/**
* Adds the [JSON object][JsonObject] produced by the [builderAction] function to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
public fun JsonArrayBuilder.addJsonObject(builderAction: JsonObjectBuilder.() -> Unit): Boolean =
add(buildJsonObject(builderAction))
/**
* Adds the [JSON array][JsonArray] produced by the [builderAction] function to a resulting JSON array.
*
* Always returns `true` similarly to [ArrayList] specification.
*/
public fun JsonArrayBuilder.addJsonArray(builderAction: JsonArrayBuilder.() -> Unit): Boolean =
add(buildJsonArray(builderAction))
/**
* Adds the given string [values] to a resulting JSON array.
*
* @return `true` if the list was changed as the result of the operation.
*/
@JvmName("addAllStrings")
@ExperimentalSerializationApi
public fun JsonArrayBuilder.addAll(values: Collection<String?>): Boolean =
addAll(values.map(::JsonPrimitive))
/**
* Adds the given boolean [values] to a resulting JSON array.
*
* @return `true` if the list was changed as the result of the operation.
*/
@JvmName("addAllBooleans")
@ExperimentalSerializationApi
public fun JsonArrayBuilder.addAll(values: Collection<Boolean?>): Boolean =
addAll(values.map(::JsonPrimitive))
/**
* Adds the given numeric [values] to a resulting JSON array.
*
* @return `true` if the list was changed as the result of the operation.
*/
@JvmName("addAllNumbers")
@ExperimentalSerializationApi
public fun JsonArrayBuilder.addAll(values: Collection<Number?>): Boolean =
addAll(values.map(::JsonPrimitive))
@DslMarker
internal annotation class JsonDslMarker
|
