-
Notifications
You must be signed in to change notification settings - Fork 612
/
JsonElement.kt
366 lines (302 loc) · 12.9 KB
/
JsonElement.kt
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
/*
* Copyright 2017-2020 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("unused")
package kotlinx.serialization.json
import kotlinx.serialization.*
import kotlinx.serialization.json.internal.*
/**
* Class representing single JSON element.
* Can be [JsonPrimitive], [JsonArray] or [JsonObject].
*
* [JsonElement.toString] properly prints JSON tree as valid JSON, taking into account quoted values and primitives.
* Whole hierarchy is serializable, but only when used with [Json] as [JsonElement] is purely JSON-specific structure
* which has a meaningful schemaless semantics only for JSON.
*
* The whole hierarchy is [serializable][Serializable] only by [Json] format.
*/
@Serializable(JsonElementSerializer::class)
public sealed class JsonElement {
/**
* Convenience method to get current element as [JsonPrimitive]
* @throws JsonException if current element is not a [JsonPrimitive]
*/
public open val primitive: JsonPrimitive
get() = error("JsonPrimitive")
/**
* Convenience method to get current element as [JsonObject]
* @throws JsonException if current element is not a [JsonObject]
*/
public open val jsonObject: JsonObject
get() = error("JsonObject")
/**
* Convenience method to get current element as [JsonArray]
* @throws JsonException if current element is not a [JsonArray]
*/
public open val jsonArray: JsonArray
get() = error("JsonArray")
/**
* Convenience method to get current element as [JsonNull]
* @throws JsonException if current element is not a [JsonNull]
*/
public open val jsonNull: JsonNull
get() = error("JsonNull")
/**
* Checks whether current element is [JsonNull]
*/
public val isNull: Boolean
get() = this === JsonNull
/**
* Checks whether element represents a [JsonObject] and contains given [key].
* Returns false if element is not a [JsonObject].
*/
public operator fun contains(key: String): Boolean {
return this is JsonObject && key in this.content
}
private fun error(element: String): Nothing =
throw JsonException("Element ${this::class} is not a $element")
}
/**
* Class representing JSON primitive value. Can be either [JsonLiteral] or [JsonNull].
*/
@Serializable(JsonPrimitiveSerializer::class)
public sealed class JsonPrimitive : JsonElement() {
/**
* Content of given element without quotes. For [JsonNull] this methods returns `null`
*/
public abstract val content: String
/**
* Content of the given element without quotes or `null` if current element is [JsonNull]
*/
public abstract val contentOrNull: String?
@Suppress("LeakingThis")
public final override val primitive: JsonPrimitive = this
/**
* Returns content of current element as int
* @throws NumberFormatException if current element is not a valid representation of number
*/
public val int: Int get() = content.toInt()
/**
* Returns content of current element as int or `null` if current element is not a valid representation of number
*/
public val intOrNull: Int? get() = content.toIntOrNull()
/**
* Returns content of current element as long
* @throws NumberFormatException if current element is not a valid representation of number
*/
public val long: Long get() = content.toLong()
/**
* Returns content of current element as long or `null` if current element is not a valid representation of number
*/
public val longOrNull: Long? get() = content.toLongOrNull()
/**
* Returns content of current element as double
* @throws NumberFormatException if current element is not a valid representation of number
*/
public val double: Double get() = content.toDouble()
/**
* Returns content of current element as double or `null` if current element is not a valid representation of number
*/
public val doubleOrNull: Double? get() = content.toDoubleOrNull()
/**
* Returns content of current element as float
* @throws NumberFormatException if current element is not a valid representation of number
*/
public val float: Float get() = content.toFloat()
/**
* Returns content of current element as float or `null` if current element is not a valid representation of number
*/
public val floatOrNull: Float? get() = content.toFloatOrNull()
/**
* Returns content of current element as boolean
* @throws IllegalStateException if current element doesn't represent boolean
*/
public val boolean: Boolean get() = content.toBooleanStrict()
/**
* Returns content of current element as boolean or `null` if current element is not a valid representation of boolean
*/
public val booleanOrNull: Boolean? get() = content.toBooleanStrictOrNull()
public override fun toString() = content
}
/**
* Class representing JSON literals: numbers, booleans and string.
* Strings are always quoted.
*
* [isString] indicates whether literal was explicitly constructed as a [String] and
* whether it should be serialized as one. E.g. `JsonLiteral("42", false)`
* and `JsonLiteral("42", true)` will be serialized as `42` and `"42"` respectively.
*/
@Serializable(JsonLiteralSerializer::class) // TODO val for body is workaround for plugin bug
public class JsonLiteral internal constructor(val body: Any, public val isString: Boolean) : JsonPrimitive() {
public override val content = body.toString()
public override val contentOrNull: String = content
/**
* Creates number literal
*/
public constructor(number: Number) : this(number, false)
/**
* Creates boolean literal
*/
public constructor(boolean: Boolean) : this(boolean, false)
/**
* Creates quoted string literal
*/
public constructor(string: String) : this(string, true)
public override fun toString() =
if (isString) buildString { printQuoted(content) }
else content
// Compare by `content` and `isString`, because body can be kotlin.Long=42 or kotlin.String="42"
public override fun equals(other: Any?): Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as JsonLiteral
if (isString != other.isString) return false
if (content != other.content) return false
return true
}
public override fun hashCode(): Int {
var result = isString.hashCode()
result = 31 * result + content.hashCode()
return result
}
}
/**
* Class representing JSON `null` value
*/
@Serializable(JsonNullSerializer::class)
public object JsonNull : JsonPrimitive() {
override val jsonNull: JsonNull = this
override val content: String = "null"
override val contentOrNull: String? = null
}
/**
* Class representing JSON object, consisting of name-value pairs, where value is arbitrary [JsonElement]
*
* Since this class also implements [Map] interface, you can use
* traditional methods like [Map.get] or [Map.getValue] to obtain Json elements.
*/
@Serializable(JsonObjectSerializer::class)
public data class JsonObject(val content: Map<String, JsonElement>) : JsonElement(), Map<String, JsonElement> by content {
override val jsonObject: JsonObject = this
/**
* Returns [JsonPrimitive] associated with given [key]
*
* @throws NoSuchElementException if element is not present
* @throws JsonException if element is present, but has invalid type
*/
public fun getPrimitive(key: String): JsonPrimitive = getValue(key) as? JsonPrimitive
?: unexpectedJson(key, "JsonPrimitive")
/**
* Returns [JsonObject] associated with given [key]
*
* @throws NoSuchElementException if element is not present
* @throws JsonException if element is present, but has invalid type
*/
public fun getObject(key: String): JsonObject = getValue(key) as? JsonObject
?: unexpectedJson(key, "JsonObject")
/**
* Returns [JsonArray] associated with given [key]
*
* @throws NoSuchElementException if element is not present
* @throws JsonException if element is present, but has invalid type
*/
public fun getArray(key: String): JsonArray = getValue(key) as? JsonArray
?: unexpectedJson(key, "JsonArray")
/**
* Returns [JsonPrimitive] associated with given [key] or `null` if element
* is not present or has different type
*/
public fun getPrimitiveOrNull(key: String): JsonPrimitive? = content[key] as? JsonPrimitive
/**
* Returns [JsonObject] associated with given [key] or `null` if element
* is not present or has different type
*/
public fun getObjectOrNull(key: String): JsonObject? = content[key] as? JsonObject
/**
* Returns [JsonArray] associated with given [key] or `null` if element
* is not present or has different type
*/
public fun getArrayOrNull(key: String): JsonArray? = content[key] as? JsonArray
/**
* Returns [J] associated with given [key]
*
* @throws NoSuchElementException if element is not present
* @throws JsonException if element is present, but has invalid type
*/
public inline fun <reified J : JsonElement> getAs(key: String): J = get(key) as? J
?: unexpectedJson(key, J::class.toString())
/**
* Returns [J] associated with given [key] or `null` if element
* is not present or has different type
*/
public inline fun <reified J : JsonElement> getAsOrNull(key: String): J? = content[key] as? J
public override fun toString(): String {
return content.entries.joinToString(
separator = ",",
prefix = "{",
postfix = "}",
transform = {(k, v) -> """"$k":$v"""}
)
}
public override fun equals(other: Any?): Boolean = content == other
public override fun hashCode(): Int = content.hashCode()
}
/**
* Class representing JSON array, consisting of indexed values, where value is arbitrary [JsonElement]
*
* Since this class also implements [List] interface, you can use
* traditional methods like [List.get] or [List.getOrNull] to obtain Json elements.
*/
@Serializable(JsonArraySerializer::class)
public data class JsonArray(val content: List<JsonElement>) : JsonElement(), List<JsonElement> by content {
public override val jsonArray: JsonArray = this
/**
* Returns [index]-th element of an array as [JsonPrimitive]
* @throws IndexOutOfBoundsException if there is no element with given index
* @throws JsonException if element has invalid type
*/
public fun getPrimitive(index: Int) = content[index] as? JsonPrimitive
?: unexpectedJson("at $index", "JsonPrimitive")
/**
* Returns [index]-th element of an array as [JsonObject]
* @throws IndexOutOfBoundsException if there is no element with given index
* @throws JsonException if element has invalid type
*/
public fun getObject(index: Int) = content[index] as? JsonObject
?: unexpectedJson("at $index", "JsonObject")
/**
* Returns [index]-th element of an array as [JsonArray]
* @throws IndexOutOfBoundsException if there is no element with given index
* @throws JsonException if element has invalid type
*/
public fun getArray(index: Int) = content[index] as? JsonArray
?: unexpectedJson("at $index", "JsonArray")
/**
* Returns [index]-th element of an array as [JsonPrimitive] or `null` if element is missing or has different type
*/
public fun getPrimitiveOrNull(index: Int) = content.getOrNull(index) as? JsonPrimitive
/**
* Returns [index]-th element of an array as [JsonObject] or `null` if element is missing or has different type
*/
public fun getObjectOrNull(index: Int) = content.getOrNull(index) as? JsonObject
/**
* Returns [index]-th element of an array as [JsonArray] or `null` if element is missing or has different type
*/
public fun getArrayOrNull(index: Int) = content.getOrNull(index) as? JsonArray
/**
* Returns [index]-th element of an array as [J]
* @throws JsonException if element has invalid type
*/
public inline fun <reified J : JsonElement> getAs(index: Int): J = content[index] as? J
?: unexpectedJson("at $index", J::class.toString())
/**
* Returns [index]-th element of an array as [J] or `null` if element is missing or has different type
*/
public inline fun <reified J : JsonElement> getAsOrNull(index: Int): J? = content.getOrNull(index) as? J
public override fun toString() = content.joinToString(prefix = "[", postfix = "]", separator = ",")
public override fun equals(other: Any?): Boolean = content == other
public override fun hashCode(): Int = content.hashCode()
}
@PublishedApi
internal fun unexpectedJson(key: String, expected: String): Nothing =
throw JsonException("Element $key is not a $expected")