The *
operator is known as the Spread Operator in Kotlin.
From the Kotlin Reference...
When we call a vararg-function, we can pass arguments one-by-one, e.g. asList(1, 2, 3), or, if we already have an array and want to pass its contents to the function, we use the spread operator (prefix the array with *):
It can be applied to an Array before passing it into a function that accepts varargs
.
For Example...
If you have a function that accepts a varied number of arguments...
fun sumOfNumbers(vararg numbers: Int): Int {
return numbers.sum()
}
You can pass an array into it like so...
val numbers = intArrayOf(2, 3, 4)
val sum = sumOfNumbers(*numbers)
println(sum)
Notes:
- The
*
operator is also the multiplication operator (of course).
- The operator can only be used when passing arguments to a function. The result of the operation cannot be stored since it yields no value (it is purely syntactic sugar).
- The operator may confuse some C/C++ programmers at first because it looks like a pointer is being de-referenced. It isn't; Kotlin has no notion of pointers.
- The operator can be used in-between other arguments when calling a vararg function. This is demonstrated in the example here.
- The operator is similar to the
apply
function in various functional programming languages.
In addition to the answers that were directly towards "what is this thing!?!", you often have the case where you have a
List
and want to pass it to a function that is expecting avararg
. For this, the conversion is:Assuming that last parameter of
someFunc
isvararg
of the same type as the elements in the list.źródło
As described in the documentation this is a spread operator:
źródło
If a function which accept a vararg(Variable number of arguments) parameter like:
fun sum(vararg data:Int) { // function body here }
Now to call this method, we can do:
sum(1,2,3,4,5)
But what if we have these value in an array, like:
val array= intArrayOf(1,2,3,4,5)
then, to call this method we have to use spread operator, like:
Here, *(spread operator) will pass all content of that array.
But wait a minute, what if we call it like this:
sum(array)
it will give us Type Mismatch compile time error:The problem is
sum
function accept avararg Int
parameter(which accept value like: 1,2,3,4,5) and if we pass array, it will be passed asIntArray
.źródło
In Java you can pass an array as is but an advantage of unpacking an array with spread operator
*
is that spread operator lets you combine the values from an array and some fixed values in a single call. Java doesn't support this.źródło
val resultOne = arrayOf(intArrayOne, intArrayTwo)
andval resultTwo = arrayOf(*intArrayOne, *intArrayTwo)
. Type ofresultOne
andresultTwo
are respectivelyArray<Int>
andArray<Array<Int>>
. I beleive that's one of the reasons