urbanairship-core/com.urbanairship.json/JsonValue

JsonValue

class JsonValue : Parcelable, JsonSerializable(source)

A JsonValue is a representation of any value that can be described using JSON. It can contain one of the following: a JsonMap, a JsonList, a Number, a Boolean, String, or it can contain null.

JsonValues can be created from Java Objects by calling wrap or from a JSON String by calling parseString. The JsonValue toString returns the JSON String representation of the object.

Types

object Companion

Properties

val boolean: Boolean?

val integer: Int?

val isBoolean: Boolean

Checks if the value is a Boolean.

val isDouble: Boolean

Checks if the value is a Double.

val isFloat: Boolean

Checks if the value is a Float.

val isInteger: Boolean

Checks if the value is an Integer.

val isJsonList: Boolean

Checks if the value is a JsonList.

val isJsonMap: Boolean

Checks if the value is a JsonMap.

val isLong: Boolean

Checks if the value is a Long.

val isNull: Boolean

If the contained value is null.

val isNumber: Boolean

Checks if the value is a Number.

val isString: Boolean

Checks if the value is a String.

val list: JsonList?

val map: JsonMap?

val number: Number?

val string: String?

val value: Any?

Gets the raw value of the JsonValue. Will be either a String, Boolean, Long, Double, Integer, JsonMap, JsonList, or null.

Functions

fun coerceString(): String?

Gets the contained value coerced into a String.

describeContents

open override fun describeContents(): Int

open operator override fun equals(other: Any?): Boolean

fun getBoolean(defaultValue: Boolean): Boolean

Gets the contained values as a boolean.

fun getDouble(defaultValue: Double): Double

Gets the contained values as an double.

fun getFloat(defaultValue: Float): Float

Gets the contained values as a float.

fun getInt(defaultValue: Int): Int

Gets the contained values as an int.

fun getLong(defaultValue: Long): Long

Gets the contained values as an long.

fun getString(defaultValue: String): String

Gets the contained values as a String.

open override fun hashCode(): Int

fun optList(): JsonList

Gets the contained values as a JsonList.

fun optMap(): JsonMap

Gets the contained values as a JsonMap.

fun optString(): String

Returns the String value or an empty String.

fun requireList(): JsonList

Requires the value to be a JsonList or a JsonException will be thrown.

fun requireMap(): JsonMap

Requires the value to be a JsonMap or a JsonException will be thrown.

fun requireString(): String

Requires the value to be a String or a JsonException will be thrown.

open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

open override fun toString(): String

Returns the JsonValue as a JSON encoded String.

fun toString(sortKeys: Boolean): String

Returns the JsonValue as a JSON encoded String with sorted keys.

fun write(stringer: JSONStringer, sortKeys: Boolean)

Helper method that is used to write the value as a JSON String.

open override fun writeToParcel(dest: Parcel, flags: Int)