common/dev.pubgkt.jsonapi

Package-level declarations

Types

JsonApiResourceDeserializer

@PubgktInternal

abstract class JsonApiResourceDeserializer<T>(serialName: String) : DeserializationStrategy<T>

Base deserializer for JSON:API resource objects.

Functions

optionalArray

@PubgktInternal

fun JsonObject.optionalArray(key: String): JsonArray?

Returns the nested JsonArray for the given key, or null when the key is absent or the value is not an array.

optionalBoolean

@PubgktInternal

fun JsonObject.optionalBoolean(key: String): Boolean?

Returns the Boolean value for the given key, or null when the key is absent, the value is JsonNull, or not a primitive.

optionalDouble

@PubgktInternal

fun JsonObject.optionalDouble(key: String): Double?

Returns the Double value for the given key, or null when the key is absent, the value is JsonNull, or not a primitive.

optionalInt

@PubgktInternal

fun JsonObject.optionalInt(key: String): Int?

Returns the Int value for the given key, or null when the key is absent, the value is JsonNull, or not a primitive.

optionalObject

@PubgktInternal

fun JsonObject.optionalObject(key: String): JsonObject?

Returns the nested JsonObject for the given key, or null when the key is absent or the value is not an object.

optionalString

@PubgktInternal

fun JsonObject.optionalString(key: String): String?

Returns the String value for the given key, or null when the key is absent, the value is JsonNull, or not a primitive.

requiredArray

@PubgktInternal

fun JsonObject.requiredArray(key: String): JsonArray

Returns the nested JsonArray for the given key, or throws SerializationException if the key is missing or not an object.

requiredBoolean

@PubgktInternal

fun JsonObject.requiredBoolean(key: String): Boolean

Returns the Boolean value for the given key, or throws SerializationException if the key is missing or null.

requiredDouble

@PubgktInternal

fun JsonObject.requiredDouble(key: String): Double

Returns the Double value for the given key, or throws SerializationException if the key is missing or null.

requiredInt

@PubgktInternal

fun JsonObject.requiredInt(key: String): Int

Returns the Int value for the given key, or throws SerializationException if the key is missing or null.

requiredObject

@PubgktInternal

fun JsonObject.requiredObject(key: String): JsonObject

Returns the nested JsonObject for the given key, or throws SerializationException if the key is missing or not an object.

requiredString

@PubgktInternal

fun JsonObject.requiredString(key: String): String

Returns the String value for the given key, or throws SerializationException if the key is missing or null.

requireId

@PubgktInternal

fun requireId(id: String?)

Asserts that the JSON:API resource id is present, smart-casting it to String at the call site via a Kotlin Contract.

requireIncluded

@PubgktInternal

fun requireIncluded(included: JsonArray?)

Asserts that a JSON:API resource has a non-null included object.

requireRelationships

@PubgktInternal

fun requireRelationships(relationships: JsonObject?)

Asserts that a JSON:API resource has a non-null relationships object.