DictionaryInterface

DictionaryInterface defines a set of methods for readonly accessing dictionary data.

Inheritors

Properties

Link copied to clipboard
abstract val count: Int

The number of the entries in the dictionary.

Link copied to clipboard
abstract val keys: List<String>

A List containing all keys, or an empty List if the dictionary has no properties.

Functions

Link copied to clipboard
abstract fun contains(key: String): Boolean

Tests whether a property exists or not. This can be less expensive than getValue(String), because it does not have to allocate an Object for the property value.

Link copied to clipboard

Subscript access to a Fragment object of the projecting result value for the given key.

Link copied to clipboard
abstract fun getArray(key: String): Array?

Get a property's value as an Array. Returns null if the property doesn't exist, or its value is not an array.

Link copied to clipboard
abstract fun getBlob(key: String): Blob?

Gets a property's value as a Blob. Returns null if the value doesn't exist, or its value is not a Blob.

Link copied to clipboard
abstract fun getBoolean(key: String): Boolean

Gets a property's value as a boolean. Returns true if the value exists, and is either true or a nonzero number.

Link copied to clipboard
abstract fun getDate(key: String): Instant?

Gets a property's value as an Instant date. JSON does not directly support dates, so the actual property value must be a string, which is then parsed according to the ISO-8601 date format (the default used in JSON.) Returns null if the value doesn't exist, is not a string, or is not parsable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.

Link copied to clipboard
abstract fun getDictionary(key: String): Dictionary?

Get a property's value as a Dictionary. Returns null if the property doesn't exist, or its value is not a dictionary.

Link copied to clipboard
abstract fun getDouble(key: String): Double

Gets a property's value as a double. Integers will be converted to double. The value true is returned as 1.0, false as 0.0. Returns 0.0 if the property doesn't exist or does not have a numeric value.

Link copied to clipboard
abstract fun getFloat(key: String): Float

Gets a property's value as a float. Integers will be converted to float. The value true is returned as 1.0, false as 0.0. Returns 0.0 if the value doesn't exist or does not have a numeric value.

Link copied to clipboard
abstract fun getInt(key: String): Int

Gets a property's value as an int. Floating point values will be rounded. The value true is returned as 1, false as 0. Returns 0 if the value doesn't exist or does not have a numeric value.

Link copied to clipboard
abstract fun getLong(key: String): Long

Gets a property's value as a long. Floating point values will be rounded. The value true is returned as 1, false as 0. Returns 0 if the value doesn't exist or does not have a numeric value.

Link copied to clipboard
abstract fun getNumber(key: String): Number?

Gets a property's value as a Number. Returns null if the value doesn't exist, or its value is not a Number.

Link copied to clipboard
abstract fun getString(key: String): String?

Gets a property's value as a String. Returns null if the value doesn't exist, or its value is not a String.

Link copied to clipboard
abstract fun getValue(key: String): Any?

Gets a property's value as an object. The object types are Blob, Array, Dictionary, Number, or String based on the underlying data type; or null if the property value is null or the property doesn't exist.

Link copied to clipboard
abstract fun toJSON(): String

Encode a Dictionary as a JSON string

Link copied to clipboard
abstract fun toMap(): Map<String, Any?>

Gets content of the current object as a Map. The values contained in the returned Map object are all JSON based values.