json/ktx.json

Package-level declarations

Types

interface JsonSerializer<T> : Json.Serializer<T>

Wrapping interface around com.badlogic.gdx.utils.Json.Serializer. Improves typing by adding nullability information and changes default parameter names.

ReadOnlyJsonSerializer

interface ReadOnlyJsonSerializer<T> : JsonSerializer<T>

Wrapping interface around com.badlogic.gdx.utils.Json.Serializer. Provides null-safety and convenient interface for serializer that is only able to read. Unlike libGDX com.badlogic.gdx.utils.Json.ReadOnlySerializer, the default implementation of the write method throws UnsupportedOperationException.

Functions

addClassTag

inline fun <T> Json.addClassTag(tag: String)

Sets a tag to use instead of the fully qualifier class name for type T. This can make the JSON easier to read.

fromJson

inline fun <T> Json.fromJson(file: FileHandle): T

Parse an object of type T from a file.

inline fun <T> Json.fromJson(string: String): T

Parse an object of type T from a string.

getTag

inline fun <T> Json.getTag(): String?

Returns the tag for type T, or null if none was defined.

readArrayValue

inline fun <T : Iterable<E>, E> Json.readArrayValue(jsonData: JsonValue, name: String? = null): T

Read an iterable value of type T with elements of type E from a jsonData attribute with a name. If name is null, this will directly read jsonData as an iterable of type T.

readOnlySerializer

inline fun <T> readOnlySerializer(crossinline read: (JsonValue) -> T): Json.Serializer<T>

Factory function to create a simplified ReadOnlyJsonSerializer, which accepts only JsonValue.

inline fun <T> readOnlySerializer(crossinline reader: (Json, JsonValue, Class<*>?) -> T): Json.Serializer<T>

Factory function to create a ReadOnlyJsonSerializer from lambda.

readValue

inline fun <T> Json.readValue(jsonData: JsonValue, name: String? = null): T

Read a value of type T from a jsonData attribute with a name. If name is null, this will directly read jsonData as an object of type T.

setElementType

inline fun <T, E> Json.setElementType(fieldName: String)

Sets the elements in a collection of type T to type E. When the element type is known, the class for each element in the collection does not need to be written unless different from the element type.

setSerializer

inline fun <T> Json.setSerializer(serializer: Json.Serializer<T>)

Registers a serializer to use for type T instead of the default behavior of serializing all of an object fields.