JSONArray

class JSONArray : JSONData, Iterable<JSONData>

A JSONArray is produced by a JSONReader when an array is read. Each element is a JSONData.

Author

Todd L Smith

Parameters

array

The array of JSONDatas. This must not be modified by the caller afterward; this call transfers ownership of the reference.

Types

Companion

object Companion

Functions

forEach

open fun forEach(p0: Consumer<in JSONData>)

get

operator fun get(index: Int): JSONData

Get a JSONData at the requested subscript.

getArray

fun getArray(index: Int, orElse: () -> JSONArray = { throw NullPointerException( "Value at index, $index, was `null` when trying to read an " + "Array.") }): JSONArray

Get a JSONArray at the requested subscript.

getArrayOrNull

fun getArrayOrNull(index: Int): JSONArray?

Get a JSONArray or null at the requested subscript.

getBigDecimal

fun getBigDecimal(index: Int, orElse: () -> BigDecimal = { throw NullPointerException( "Value at index, $index, was `null` when trying to read a " + "BigDecimal.") }): BigDecimal

Get a BigDecimal at the requested subscript.

getBigDecimalOrNull

fun getBigDecimalOrNull(index: Int): BigDecimal?

Get a BigDecimal or null at the requested subscript.

getBigInteger

fun getBigInteger(index: Int, orElse: () -> BigInteger = { throw NullPointerException( "Value at index, $index, was `null` when trying to read a " + "BigInteger.") }): BigInteger

Get a BigInteger at the requested subscript.

getBigIntegerOrNull

fun getBigIntegerOrNull(index: Int): BigInteger?

Get a BigInteger or null at the requested subscript.

getBoolean

fun getBoolean(index: Int, orElse: () -> Boolean = { throw NullPointerException( "Value at index, $index, was `null` when trying to read a " + "boolean.") }): Boolean

Get a Boolean at the requested subscript.

getBooleanOrNull

fun getBooleanOrNull(index: Int): Boolean?

Get a Boolean or null at the requested subscript.

getInt

fun getInt(index: Int, orElse: () -> Int = { throw NullPointerException( "Value at index, $index, was `null` when trying to read an " + "Int.") }): Int

Get a Int at the requested subscript.

getIntOrNull

fun getIntOrNull(index: Int): Int?

Get a Int or null at the requested subscript.

getLong

fun getLong(index: Int, orElse: () -> Long = { throw NullPointerException( "Value at index, $index, was `null` when trying to read a " + "Long.") }): Long

Get a Long at the requested subscript.

getLongOrNull

fun getLongOrNull(index: Int): Long?

Get a Long or null at the requested subscript.

getNumber

fun getNumber(index: Int, orElse: () -> JSONNumber = { throw NullPointerException( "Value at index, $index, was `null` when trying to read a " + "number.") }): JSONNumber

Get a JSONNumber at the requested subscript.

getNumberOrNull

fun getNumberOrNull(index: Int): JSONNumber?

Get a JSONNumber or null at the requested subscript.

getObject

fun getObject(index: Int, orElse: () -> JSONObject = { throw NullPointerException( "Value at index, $index, was `null` when trying to read an " + "Object.") }): JSONObject

Get a JSONObject at the requested subscript.

getObjectOrNull

fun getObjectOrNull(index: Int): JSONObject?

Get a JSONObject or null at the requested subscript.

getString

fun getString(index: Int, orElse: () -> String = { throw NullPointerException( "Value at index, $index, was `null` when trying to read a " + "String.") }): String

Get a String at the requested subscript.

getStringOrNull

fun getStringOrNull(index: Int): String?

Get a String or null at the requested subscript.

iterator

open operator override fun iterator(): ListIterator<JSONData>

size

fun size(): Int

Answer the length of the receiver.

spliterator

open fun spliterator(): Spliterator<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.

bigDecimals

val bigDecimals: List<BigDecimal>

Extract a List of BigDecimal, throwing a ClassCastException if any elements are non-numeric.

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.

bigIntegers

val bigIntegers: List<BigInteger>

Extract a List of BigInteger, throwing a ClassCastException if any elements are non-numeric, or an ArithmeticException if any elements are non-integral. The first element to fail determines which exception is thrown.

boolean

open val boolean: Boolean

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

booleans

val booleans: List<Boolean>

Extract a List of Booleans, throwing a ClassCastException if any element is not a boolean.

double

open val double: Double

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

doubles

val doubles: List<Double>

Extract a List of Doubles, throwing a ClassCastException if any elements are non-numeric.

float

open val float: Float

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

floats

val floats: List<Float>

Extract a List of Floats, throwing a ClassCastException if any elements are non-numeric.

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.

ints

val ints: List<Int>

Extract a List of Ints, throwing a ClassCastException if any elements are non-numeric, or an ArithmeticException if any elements are non-integral or overflow an Int. The first element to fail determines which exception is thrown.

isArray

open override 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 val isObject: Boolean

Is the receiver a JSON?

isString

open val isString: Boolean

Is the receiver a JSON string?

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.

longs

val longs: List<Long>

Extract a List of Longs, throwing a ClassCastException if any elements are non-numeric, or an ArithmeticException if any elements are non-integral or overflow a Long. The first element to fail determines which exception is thrown.

string

open val string: String

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

strings

val strings: List<String>

Extract a List of Strings, throwing a ClassCastException if any element is not a string.