kotlin-stdlib / kotlin.collections / buildList

buildList

Common

JVM

Native

1.3

@ExperimentalStdlibApi inline fun <E> buildList(
    builderAction: MutableList<E>.() -> Unit
): List<E>

Builds a new read-only List by populating a MutableList using the given builderAction and returning a read-only list with the same elements.

The list passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function produces an unspecified behavior.



fun main(args: Array<String>) {
//sampleStart
val x = listOf('b', 'c')

val y = buildList(x.size + 2) {
    add('a')
    addAll(x)
    add('d')
}

println(y) // [a, b, c, d]
//sampleEnd
}

Common

JVM

Native

1.3

@ExperimentalStdlibApi inline fun <E> buildList(
    capacity: Int, 
    builderAction: MutableList<E>.() -> Unit
): List<E>

Builds a new read-only List by populating a MutableList using the given builderAction and returning a read-only list with the same elements.

The list passed as a receiver to the builderAction is valid only inside that function. Using it outside of the function produces an unspecified behavior.

capacity is used to hint the expected number of elements added in the builderAction.



fun main(args: Array<String>) {
//sampleStart
val x = listOf('b', 'c')

val y = buildList(x.size + 2) {
    add('a')
    addAll(x)
    add('d')
}

println(y) // [a, b, c, d]
//sampleEnd
}

Exceptions

IllegalArgumentException - if the given capacity is negative.