Json

Wrapper for a native JSON object.

This class is an implementation of a simple JSON object.

Since it is based on Pointer, all methods in this class do not require to be run on the main thread, however they require you to run them always on the same thread. To pass it a different thread, you can change its thread but beware of the possible consequences.

Please read documentation of Pointer on how you should manage pointer's lifetime.

Constructors

Json

constructor()

Create a null JSON object.

constructor(value: Boolean)

Create a boolean JSON object.

constructor(value: Double)

Create a double-precision floating-point JSON object.

constructor(value: Int)

Create an integer JSON object.

constructor(value: Long)

Create an integer JSON object.

constructor(@NonNull value: Json.Array)

Create an array JSON object.

constructor(@NonNull value: Json.Dict)

Create a dictionary JSON object.

constructor(@NonNull value: String)

Create a string JSON object.

Types

Array

class Array : Pointer, Cloneable, List<Json>

JSON array.

Dict

class Dict : Pointer, Cloneable, Map<String, Json>

JSON dictionary.

Type

@Retention(value = RetentionPolicy.SOURCE)

annotation class Type

JSON value type.

Properties

ARRAY

val ARRAY: Int = 2

Array type.

BOOL

val BOOL: Int = 4

Boolean value type.

DICT

val DICT: Int = 3

Dictionary type.

DOUBLE

val DOUBLE: Int = 6

Double-precision floating-point number type.

INT

val INT: Int = 5

Long integer type.

NULL

val NULL: Int = 0

No value type.

STRING

val STRING: Int = 1

String type.

Functions

asArray

@Nullable

open fun asArray(): Json.Array

Return the JSON object as array.

asBool

@Nullable

open fun asBool(): Boolean

open fun asBool(def: Boolean): Boolean

Return the JSON object as boolean value.

asDict

@Nullable

open fun asDict(): Json.Dict

Return the JSON object as dictionary.

asDouble

@Nullable

open fun asDouble(): Double

open fun asDouble(def: Double): Double

Return the JSON object as double-precision floating-point number.

asInt

@Nullable

open fun asInt(): Integer

open fun asInt(def: Int): Int

Return the JSON object as integer.

asLong

@Nullable

open fun asLong(): Long

open fun asLong(def: Long): Long

Return the JSON object as long integer.

asString

@Nullable

open fun asString(): String

@NonNull

open fun asString(@NonNull def: String): String

Return the JSON object as string.

changeThread

open fun changeThread()

Change thread this pointer can be accessed from to the current one.

clone

@NonNull

open fun clone(): Json

Deep-copy the JSON object.

open fun close()

Close the native pointer.

abstract fun close()

dump

open fun dump(@NonNull stream: OutputStream)

Dump the JSON object to an output stream.

equals

open fun equals(@Nullable o: Any): Boolean

Check if the JSON object is equal to another object.

get

@Nullable

open fun get(): Any

Return as a value object.

getAtPath

@Nullable

open fun getAtPath(@NonNull path: String): Json

Get JSON object at path.

getBool

open fun getBool(): Boolean

Return the value converted to a boolean.

getDouble

open fun getDouble(): Double

Return the value converted to a double-precision floating-point number.

getInt

open fun getInt(): Int

Return the value converted to an integer.

getLong

open fun getLong(): Long

Return the value converted to a long integer.

getString

@NonNull

open fun getString(): String

Return the value converted to a string.

getType

open fun getType(): Int

Get type of the JSON object.

hashCode

open fun hashCode(): Int

Get hash code.

isArray

open fun isArray(): Boolean

Check if the JSON object is an array.

isBool

open fun isBool(): Boolean

Check if the JSON object is a boolean.

isClosed

open fun isClosed(): Boolean

Check if the native pointer is closed.

isDict

open fun isDict(): Boolean

Check if the JSON object is a dictionary.

isDouble

open fun isDouble(): Boolean

Check if the JSON object is a double-precision floating-point number.

isInt

open fun isInt(): Boolean

Check if the JSON object is an integer.

isMutable

open fun isMutable(): Boolean

Check if the native pointer is mutable.

isNull

open fun isNull(): Boolean

Check if the JSON object is a null.

isSamePointer

open fun isSamePointer(@NonNull other: Pointer): Boolean

Check if the pointer is the same as in another pointer.

isString

open fun isString(): Boolean

Check if the JSON object is a string.

parse

@Nullable

open fun parse(@Nullable file: File): Json

Parse a file with JSON into a tree.

@Nullable

open fun parse(@Nullable stream: InputStream): Json

@Nullable

open fun parse(@Nullable json: String): Json

Parse a JSON string into a tree.

reset

open fun reset()

Reset the JSON object.

set

open fun set(value: Boolean)

Set to a boolean value.

open fun set(@NonNull array: Json.Array)

Set to an array.

open fun set(@NonNull dict: Json.Dict)

Set to a dictionary.

open fun set(value: Double)

Set to a double-precision floating-point number.

open fun set(@NonNull string: String)

Set to a string.

open fun set(value: Long)

Set to an integer.

setType

open fun setType(type: Int)

Set type of the JSON object.

toJson

@CheckResult

@NonNull

open fun ~~toJson~~(@Nullable object: Any): Json

Create JSON from Java object.

toString

@NonNull

open fun toString(): String

@NonNull

open fun toString(pretty: Boolean): String

Return the JSON object as a JSON string.