urbanairship-core/com.urbanairship.json/JsonMap

JsonMap

open class JsonMap : Iterable<T> , JsonSerializable

An immutable mapping of String keys to JsonValues.

Constructors

Link copied to clipboard
constructor(@Nullable map: Map<String, JsonValue>)
Creates a JsonMap from a Map.

Types

Link copied to clipboard
open class Builder
Builder class for com.urbanairship.json.JsonMap Objects.

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun containsKey(@NonNull key: String): Boolean
Returns whether this map contains the specified key.
Link copied to clipboard
open fun containsValue(@NonNull value: JsonValue): Boolean
Returns whether this map contains the specified value.
Link copied to clipboard
@NonNull
open fun entrySet(): Set<Map.Entry<String, JsonValue>>
Returns a set containing all of the mappings in this map.
Link copied to clipboard
open fun equals(@Nullable object: Any): Boolean
Link copied to clipboard
@Nullable
open fun get(@NonNull key: String): JsonValue
Returns the value of the mapping with the specified key.
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun isEmpty(): Boolean
Returns whether this map is empty.
Link copied to clipboard
open fun isNotEmpty(): Boolean
Returns whether this map is not empty.
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun keySet(): Set<String>
Returns a set of the keys contained in this map.
Link copied to clipboard
@NonNull
open fun newBuilder(): JsonMap.Builder
Factory method to create a new JSON map builder.
Link copied to clipboard
@NonNull
open fun opt(@NonNull key: String): JsonValue
Returns the optional value in the map with the specified key.
Link copied to clipboard
@NonNull
open fun require(@NonNull key: String): JsonValue
Returns the required value in the map with the specified key.
Link copied to clipboard
open fun size(): Int
Returns the number of elements in this map.
Link copied to clipboard
@NonNull
open fun toJsonValue(): JsonValue
Returns the objects represented as a JsonValue.
Link copied to clipboard
@NonNull
open fun toString(): String
Returns the JsonMap as a JSON encoded String.
@NonNull
open fun toString(@NonNull sortKeys: Boolean): String
Returns the JsonMap as a JSON encoded String with sorted keys.
Link copied to clipboard
@NonNull
open fun values(): Collection<JsonValue>
Returns a collection of the values contained in this map.

Inherited functions

Link copied to clipboard
fun JsonMap.extend(vararg fields: Pair<String, *>): JsonMap
Link copied to clipboard
open fun forEach(p: Consumer<in T>)
Link copied to clipboard
fun JsonMap.isoDateAsMilliseconds(key: String, defaultValue: Long? = null): Long?

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

Link copied to clipboard
inline fun <T> JsonMap.optionalField(key: String): T?

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

Link copied to clipboard
fun JsonMap.optionalList(key: String): JsonList?

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

Link copied to clipboard
fun JsonMap.optionalMap(key: String): JsonMap?

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

Link copied to clipboard
inline fun <T> JsonMap.requireField(key: String): T

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

Link copied to clipboard
fun JsonMap.requireList(key: String): JsonList

Gets a list with the given key from the JsonMap.

Link copied to clipboard
fun JsonMap.requireMap(key: String): JsonMap

Gets a map with the given key from the JsonMap.

Link copied to clipboard
open fun spliterator(): Spliterator<T>