jvmMain.jdk8.kotlin.jvm.optionals.Optionals.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-stdlib Show documentation

Kotlin Standard Library

There is a newer version: 2.1.0-RC

/*
 * Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
 * Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
 */
@file:Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")
package kotlin.jvm.optionals

import java.util.Optional

/**
 * Returns this [Optional]'s value if [present][Optional.isPresent], or otherwise `null`.
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public fun  Optional.getOrNull(): T? = orElse(null)

/**
 * Returns this [Optional]'s value if [present][Optional.isPresent], or otherwise [defaultValue].
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public fun  Optional.getOrDefault(defaultValue: T): T = if (isPresent) get() else defaultValue

/**
 * Returns this [Optional]'s value if [present][Optional.isPresent], or otherwise the result of the [defaultValue] function.
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public inline fun  Optional.getOrElse(defaultValue: () -> T): T =
    if (isPresent) get() else defaultValue()

/**
 * Appends this [Optional]'s value to the given [destination] collection if [present][Optional.isPresent].
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public fun > Optional.toCollection(destination: C): C {
    if (isPresent) {
        destination.add(get())
    }
    return destination
}

/**
 * Returns a new read-only list of this [Optional]'s value if [present][Optional.isPresent], or otherwise an empty list.
 * The returned list is serializable (JVM).
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public fun  Optional.toList(): List =
    if (isPresent) listOf(get()) else emptyList()

/**
 * Returns a new read-only set of this [Optional]'s value if [present][Optional.isPresent], or otherwise an empty set.
 * The returned set is serializable (JVM).
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public fun  Optional.toSet(): Set =
    if (isPresent) setOf(get()) else emptySet()

/**
 * Returns a new sequence for this [Optional]'s value if [present][Optional.isPresent], or otherwise an empty sequence.
 */
@SinceKotlin("1.8")
@WasExperimental(ExperimentalStdlibApi::class)
public fun  Optional.asSequence(): Sequence =
    if (isPresent) sequenceOf(get()) else emptySequence()