commons-provider/xyz.xenondevs.commons.provider/getMod

getMod

@JvmName(name = "listGetMod")
fun <T> Provider<List<T>>.getMod(index: Int): Provider<T>
@JvmName(name = "listGetMod")
fun <T> Provider<List<T>>.getMod(index: Provider<Int>): Provider<T>

Creates and returns a new Provider that maps to the element at index modulo the list size.

The returned provider will only be stored in a WeakReference in the parent provider (this).

@JvmName(name = "arrayGetMod")
fun <T> Provider<Array<T>>.getMod(index: Int): Provider<T>
@JvmName(name = "arrayGetMod")
fun <T> Provider<Array<T>>.getMod(index: Provider<Int>): Provider<T>

Creates and returns a new Provider that maps to the element at index modulo the array size.

The returned provider will only be stored in a WeakReference in the parent provider (this).