commonMain.co.touchlab.stately.collections.Functions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stately-collections-jvm Show documentation

Multithreaded Kotlin Multiplatform Utilities

The newest version!

/*
 * Copyright (C) 2018 Touchlab, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package co.touchlab.stately.collections

/**
 * Creates a copy-on-write list. On the JVM, will return
 * [https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/CopyOnWriteArrayList.html](CopyOnWriteArrayList).
 * On Native, there is a native implementation which maintains and updates a frozen ArrayList.
 */
expect fun  frozenCopyOnWriteList(collection: Collection? = null): MutableList

@Deprecated(
    message = "Replacing Atomic collections with isolated state collections (modele `stately-iso-collections`)",
    replaceWith = ReplaceWith(
        "sharedMutableListOf()",
        "co.touchlab.stately.collections.sharedMutableListOf"
    )
)
fun  frozenLinkedList(stableIterator: Boolean = false): MutableList = if (stableIterator) {
    CopyOnIterateLinkedList()
} else {
    SharedLinkedList()
}

@Deprecated(
    message = "Replacing Atomic collections with isolated state collections (modele `stately-iso-collections`)",
    replaceWith = ReplaceWith(
        "sharedMutableMapOf()",
        "co.touchlab.stately.collections.sharedMutableMapOf"
    )
)
fun  frozenHashMap(initialCapacity: Int = 16, loadFactor: Float = 0.75.toFloat()): MutableMap =
    SharedHashMap(initialCapacity, loadFactor)

@Deprecated(
    message = "Replacing Atomic collections with isolated state collections (modele `stately-iso-collections`)",
    replaceWith = ReplaceWith(
        "sharedMutableSetOf()",
        "co.touchlab.stately.collections.sharedMutableSetOf"
    )
)
fun  frozenHashSet(): MutableSet = SharedSet()

fun  frozenLruCache(maxCacheSize: Int, onRemove: (MutableMap.MutableEntry) -> Unit = {}): LruCache =
    SharedLruCache(maxCacheSize, onRemove)

/**
 * Creates a list from an Iterator.
 */
fun  Iterator.toList(): List {
    val result = mutableListOf()
    while (hasNext()) {
        result.add(next())
    }
    return result
}