All Implemented Interfaces:

io.kjson.JSONStructure , io.kjson.JSONValue , kotlin.collections.Collection , kotlin.collections.Iterable , kotlin.collections.List
```
public final class JSONArray
 implements JSONStructure<Int>, List<JSONValue>
                    
```
A JSON array. As allowed by the JSON specification, array members may be primitive types, objects, other arrays or null.
A JSONArray is immutable; instances may be created dynamically using the build function and the Builder class.
The JSONArray class implements the Kotlin List interface; all the functions of that interface are available, including indexed access, iteration over the list contents and comparison with another list.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`JSONArray.Builder`	JSONArray builder class.
`public class`	`JSONArray.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final JSONArray`	`asArray`
`private final JSONArray`	`asArrayOrNull`
`private final Integer`	`size`
`public final static JSONArray.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final JSONArray`	`getAsArray()`
`final JSONArray`	`getAsArrayOrNull()`
`Integer`	`getSize()`	The size of the structure.
`Unit`	`appendTo(Appendable a)`	Append as a JSON string to an Appendable.
`final Unit`	`appendJSONLinesTo(Appendable a)`	Append in JSON Lines form to an Appendable.
`final Unit`	`appendJSONLines(Appendable a)`	Append in JSON Lines form to an Appendable.
`String`	`toJSON()`	Convert to a JSON string.
`final String`	`toJSONLines()`	Convert to a string in JSON Lines form.
`Unit`	`outputTo(IntConsumer out)`	Output as a JSON string to an IntConsumer.
`Unit`	`output(IntConsumer out)`	Output as a JSON string to an IntConsumer.
`final Unit`	`outputJSONLinesTo(IntConsumer out)`	Output in JSON Lines form to an IntConsumer.
`final Unit`	`outputJSONLines(IntConsumer out)`	Output in JSON Lines form to an IntConsumer.
`Unit`	`coOutputTo(SuspendFunction1<Character, Unit> out)`	Output as a JSON string to a CoOutput.
`Unit`	`coOutput(SuspendFunction1<Character, Unit> out)`	Output as a JSON string to a CoOutput.
`final Unit`	`coOutputJSONLinesTo(SuspendFunction1<Character, Unit> out)`	Output in JSON lines form to a CoOutput.
`final Unit`	`coOutputJSONLines(SuspendFunction1<Character, Unit> out)`	Output in JSON lines form to a CoOutput.
`Boolean`	`isEmpty()`	Return `true` if the array is empty.
`JSONValue`	`get(Integer index)`	Get the value at the given index.
`JSONArray`	`subList(Integer fromIndex, Integer toIndex)`	Get a sub-list of the array.
`final Unit`	`forEachItem(Function1<JSONValue, Unit> func)`	Apply a function to each item in the array.
`final Unit`	`forEachItemIndexed(Function2<Integer, JSONValue, Unit> func)`	Apply a function to each item in the array, supplying the index.
`Boolean`	`equals(Object other)`	Compare the array to another value, applying the rule in Java for comparing `List`s.
`Integer`	`hashCode()`	Get the hash code for the array, applying the rule in Java for `List` hash codes.
`String`	`toString()`	Convert to a String (converts to JSON).

Methods inherited from class io.kjson.JSONStructure
getArray, getBoolean, getByte, getDecimal, getInt, getLong, getObject, getShort, getString, getUByte, getUInt, getULong, getUShort, isNotEmpty
Methods inherited from class kotlin.collections.List
contains, containsAll, indexOf, iterator, lastIndexOf, listIterator, listIterator, spliterator
Methods inherited from class kotlin.collections.Iterable
forEach
Methods inherited from class kotlin.collections.Collection
parallelStream, stream, toArray
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

getAsArray
```
 final JSONArray getAsArray()
```

getAsArrayOrNull
```
 final JSONArray getAsArrayOrNull()
```

getSize
```
 Integer getSize()
```
The size of the structure.

appendTo
```
 Unit appendTo(Appendable a)
```
Append as a JSON string to an Appendable.

appendJSONLinesTo
```
 final Unit appendJSONLinesTo(Appendable a)
```
Append in JSON Lines form to an Appendable.

appendJSONLines

@Deprecated(message = "renamed to appendJSONLinesTo", replaceWith = @ReplaceWith(imports = {}, expression = "appendJSONLinesTo(a)")) final Unit appendJSONLines(Appendable a)

Append in JSON Lines form to an Appendable.

toJSON
```
 String toJSON()
```
Convert to a JSON string.

toJSONLines
```
 final String toJSONLines()
```
Convert to a string in JSON Lines form.

outputTo
```
 Unit outputTo(IntConsumer out)
```
Output as a JSON string to an IntConsumer.

output

@Deprecated(message = "renamed to outputTo", replaceWith = @ReplaceWith(imports = {}, expression = "outputTo(out)")) Unit output(IntConsumer out)

Output as a JSON string to an IntConsumer.

outputJSONLinesTo
```
 final Unit outputJSONLinesTo(IntConsumer out)
```
Output in JSON Lines form to an IntConsumer.

outputJSONLines

@Deprecated(message = "renamed to outputJSONLinesTo", replaceWith = @ReplaceWith(imports = {}, expression = "outputJSONLinesTo(out)")) final Unit outputJSONLines(IntConsumer out)

Output in JSON Lines form to an IntConsumer.

coOutputTo

 Unit coOutputTo(SuspendFunction1<Character, Unit> out)

Output as a JSON string to a CoOutput.

coOutput

@Deprecated(message = "renamed to coOutputTo(out)", replaceWith = @ReplaceWith(imports = {}, expression = "coOutputTo(out)")) Unit coOutput(SuspendFunction1<Character, Unit> out)

Output as a JSON string to a CoOutput.

coOutputJSONLinesTo

 final Unit coOutputJSONLinesTo(SuspendFunction1<Character, Unit> out)

Output in JSON lines form to a CoOutput.

coOutputJSONLines

@Deprecated(message = "renamed to coOutputJSONLinesTo", replaceWith = @ReplaceWith(imports = {}, expression = "coOutputJSONLinesTo(out)")) final Unit coOutputJSONLines(SuspendFunction1<Character, Unit> out)

Output in JSON lines form to a CoOutput.

isEmpty
```
 Boolean isEmpty()
```
Return true if the array is empty.

get
```
 JSONValue get(Integer index)
```
Get the value at the given index.

subList

 JSONArray subList(Integer fromIndex, Integer toIndex)

Get a sub-list of the array.

forEachItem

 final Unit forEachItem(Function1<JSONValue, Unit> func)

Apply a function to each item in the array.

forEachItemIndexed
```
 final Unit forEachItemIndexed(Function2<Integer, JSONValue, Unit> func)
```
Apply a function to each item in the array, supplying the index.

equals
```
 Boolean equals(Object other)
```
Compare the array to another value, applying the rule in Java for comparing Lists.

hashCode
```
 Integer hashCode()
```
Get the hash code for the array, applying the rule in Java for List hash codes.

toString
```
 String toString()
```
Convert to a String (converts to JSON).

Class JSONArray

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class io.kjson.JSONStructure

Methods inherited from class kotlin.collections.List

Methods inherited from class kotlin.collections.Iterable

Methods inherited from class kotlin.collections.Collection

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getAsArray

getAsArrayOrNull

getSize

appendTo

appendJSONLinesTo

appendJSONLines

toJSON

toJSONLines

outputTo

output

outputJSONLinesTo

outputJSONLines

coOutputTo

coOutput

coOutputJSONLinesTo

coOutputJSONLines

isEmpty

get

subList

forEachItem

forEachItemIndexed

equals

hashCode

toString