urbanairship-core/com.urbanairship.json/JsonMap

JsonMap

class JsonMap(map: Map<String, JsonValue>?) : Iterable<Map.Entry<String, JsonValue>> , JsonSerializable(source)

An immutable mapping of String keys to JsonValues.

Constructors

constructor(map: Map<String, JsonValue>?)

Types

Builder class for com.urbanairship.json.JsonMap Objects.

object Companion

Properties

val isEmpty: Boolean

val isNotEmpty: Boolean

val map: Map<String, JsonValue>

Gets the JsonMap as a Map.

Functions

fun containsKey(key: String): Boolean

Returns whether this map contains the specified key.

fun containsValue(value: JsonValue): Boolean

Returns whether this map contains the specified value.

fun entrySet(): Set<Map.Entry<String, JsonValue>>

Returns a set containing all of the mappings in this map. Each mapping is an instance of Map.Entry. As the set is backed by this map, changes in one will be reflected in the other.

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

operator fun get(key: String): JsonValue?

Returns the value of the mapping with the specified key.

open override fun hashCode(): Int

open operator override fun iterator(): Iterator<Map.Entry<String, JsonValue>>

fun keySet(): Set<String>

Returns a set of the keys contained in this map. The set is backed by this map so changes to one are reflected by the other. The set does not support adding.

fun opt(key: String): JsonValue

Returns the optional value in the map with the specified key. If the value is not in the map JsonValue.NULL will be returned instead null.

fun require(key: String): JsonValue

Returns the required value in the map with the specified key. If the value is not in the map an exception will be thrown.

fun size(): Int

Returns the number of elements in this map.

open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

open override fun toString(): String

Returns the JsonMap as a JSON encoded String.

fun toString(sortKeys: Boolean): String

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

fun values(): Collection<JsonValue>

Returns a collection of the values contained in this map.

fun write(stringer: JSONStringer, sortKeys: Boolean)

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

Inherited functions

fun JsonMap.extend(vararg fields: Pair<String, *>): JsonMap

isoDateAsMilliseconds

fun JsonMap.isoDateAsMilliseconds(key: String, defaultValue: Long? = null): Long?

Gets the field with the given key and parses it as a ISO date string.

inline fun <T> JsonMap.optionalField(key: String): T?

Gets the field with the given key from the JsonMap, or null if not defined.

fun JsonMap.optionalList(key: String): JsonList?

Gets a list with the given key from the JsonMap, or an null if not defined.

fun JsonMap.optionalMap(key: String): JsonMap?

Gets a map with the given key from the JsonMap, or an null if not defined.

inline fun <T> JsonMap.requireField(key: String): T

Gets the field with the given key from the JsonMap, ensuring it is non-null.

fun JsonMap.requireList(key: String): JsonList

Gets a list with the given key from the JsonMap.

fun JsonMap.requireMap(key: String): JsonMap

Gets a map with the given key from the JsonMap.