avail-json/org.availlang.json/JSONObject

JSONObject

class JSONObject : JSONData, Iterable<Map.Entry<String, JSONData>>

A JSONObject is produced by a JSONReader when an object is read. Each key of the object is a String and each value is a JSONData.

Author

Todd L Smith

Parameters

map

The field assignments of the JSONObject as a Map from keys to values. This must not be modified by the caller afterward; this call transfers ownership of the reference.

Types

Companion

object Companion

Functions

containsKey

fun containsKey(k: String): Boolean

Does the JSONObject include a binding for the specified key?

forEach

open fun forEach(p0: Consumer<in Map.Entry<String, JSONData>>)

get

operator fun get(k: String): JSONData

Get a JSONData associated with requested key.

getArray

fun getArray(k: String, orElse: () -> JSONArray = { throw NullPointerException("Key, $k, not found.") }): JSONArray

Get a JSONArray associated with requested key.

getArrayOrNull

fun getArrayOrNull(k: String): JSONArray?

Get a JSONArray associated with requested key, or null if no such key exists.

getBigDecimal

fun getBigDecimal(k: String, orElse: () -> BigDecimal = { throw NullPointerException("Key, $k, not found.") }): BigDecimal

Get a BigDecimal associated with requested key.

getBigDecimalOrNull

fun getBigDecimalOrNull(k: String): BigDecimal?

Get a BigDecimal associated with requested key, or null if no such key exists.

getBigInteger

fun getBigInteger(k: String, orElse: () -> BigInteger = { throw NullPointerException("Key, $k, not found.") }): BigInteger

Get a BigInteger associated with requested key.

getBigIntegerOrNull

fun getBigIntegerOrNull(k: String): BigInteger?

Get a BigInteger associated with requested key, or null if no such key exists.

getBoolean

fun getBoolean(k: String, orElse: () -> Boolean = { throw NullPointerException("Key, $k, not found.") }): Boolean

Get a Boolean associated with requested key.

getBooleanOrNull

fun getBooleanOrNull(k: String): Boolean?

Get a Boolean associated with requested key, or null if no such key exists.

getDouble

fun getDouble(k: String, orElse: () -> Double = { throw NullPointerException("Key, $k, not found.") }): Double

Get a Double associated with requested key.

getDoubleOrNull

fun getDoubleOrNull(k: String): Double?

Get a Double associated with requested key, or null if no such key exists.

getFloat

fun getFloat(k: String, orElse: () -> Float = { throw NullPointerException("Key, $k, not found.") }): Float

Get a Float associated with requested key.

getFloatOrNull

fun getFloatOrNull(k: String): Float?

Get a Float associated with requested key, or null if no such key exists.

getInt

fun getInt(k: String, orElse: () -> Int = { throw NullPointerException("Key, $k, not found.") }): Int

Get a Int associated with requested key.

getIntOrNull

fun getIntOrNull(k: String): Int?

Get a Int associated with requested key, or null if no such key exists.

getLong

fun getLong(k: String, orElse: () -> Long = { throw NullPointerException("Key, $k, not found.") }): Long

Get a Long associated with requested key.

getLongOrNull

fun getLongOrNull(k: String): Long?

Get a Long associated with requested key, or null if no such key exists.

getNumber

fun getNumber(k: String, orElse: () -> JSONNumber = { throw NullPointerException("Key, $k, not found.") }): JSONNumber

Get a JSONNumber associated with requested key.

getNumberOrNull

fun getNumberOrNull(k: String): JSONNumber?

Get a JSONNumber associated with requested key, or null if no such key exists.

getObject

fun getObject(k: String, orElse: () -> JSONObject = { throw NullPointerException("Key, $k, not found.") }): JSONObject

Get a JSONObject associated with requested key.

getObjectOrNull

fun getObjectOrNull(k: String): JSONObject?

Get a JSONObject associated with requested key, or null if no such key exists.

getString

fun getString(k: String, orElse: () -> String = { throw NullPointerException("Key, $k, not found.") }): String

Get a String associated with requested key.

getStringOrNull

fun getStringOrNull(k: String): String?

Get a String associated with requested key, or null if no such key exists.

iterator

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

map

fun <K, V> map(transform: (String, JSONData) -> Pair<K, V>): Map<K, V>

Transform the fields of this JSONObject into a Map with the keys of the map being the transformed keys of this JSONObject and the values of the map being the corresponding transformed values of this JSONObject.

spliterator

open fun spliterator(): Spliterator<Map.Entry<String, JSONData>>

writeTo

open override fun writeTo(writer: JSONWriter)

Emit a JSON representation of the receiver onto the specified writer.

Properties

bigDecimal

open val bigDecimal: BigDecimal

If this is a JSONNumber, extract its value as a BigDecimal, otherwise throw a ClassCastException.

bigInteger

open val bigInteger: BigInteger

If this is a JSONNumber, extract its value as a BigInteger, otherwise throw a ClassCastException. If the value has a non-zero fractional part, throw an ArithmeticException.

boolean

open val boolean: Boolean

Extract a Boolean, or throw a ClassCastException if the value is not a boolean.

double

open val double: Double

If this is a JSONNumber, extract its value as a Double, otherwise throw a ClassCastException.

float

open val float: Float

If this is a JSONNumber, extract its value as a Float, otherwise throw a ClassCastException.

int

open val int: Int

If this is a JSONNumber, extract its value as an Int, otherwise throw a ClassCastException. If the value has a non-zero fractional part or is out of range, throw an ArithmeticException.

isArray

open val isArray: Boolean

Is the receiver a JSON?

isBoolean

open val isBoolean: Boolean

Is the receiver a JSON boolean?

isNull

open val isNull: Boolean

Is the receiver a JSON null?

isNumber

open val isNumber: Boolean

Is the receiver a JSON?

isObject

open override val isObject: Boolean

Is the receiver a JSON?

isString

open val isString: Boolean

Is the receiver a JSON string?

jsonFormattedString

open val jsonFormattedString: String

The formatted JSON String of this JSONFriendly as the top-level JSON element.

jsonPrettyPrintedFormattedString

open val jsonPrettyPrintedFormattedString: String

The pretty-printed formatted JSON String of this JSONFriendly as the top-level JSON element.

long

open val long: Long

If this is a JSONNumber, extract its value as a Long, otherwise throw a ClassCastException. If the value has a non-zero fractional part or is out of range, throw an ArithmeticException.

string

open val string: String

Extract a String, or throw a ClassCastException if the value is not a string.