jvmMain.jdk8.kotlin.streams.Streams.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 for JVM
There is a newer version: 2.1.0-RC
/*
 * Copyright 2010-2017 JetBrains s.r.o.
 *
 * 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.
 */

@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
@file:JvmName("StreamsKt")
@file:kotlin.jvm.JvmPackageName("kotlin.streams.jdk8")
package kotlin.streams

import java.util.*
import java.util.stream.*

/**
 * Creates a [Sequence] instance that wraps the original stream iterating through its elements.
 *
 * @sample samples.streams.Streams.streamAsSequence
 */
@SinceKotlin("1.2")
public fun  Stream.asSequence(): Sequence = Sequence { iterator() }

/**
 * Creates a [Sequence] instance that wraps the original stream iterating through its elements.
 *
 * @sample samples.streams.Streams.intStreamAsSequence
 */
@SinceKotlin("1.2")
public fun IntStream.asSequence(): Sequence = Sequence { iterator() }

/**
 * Creates a [Sequence] instance that wraps the original stream iterating through its elements.
 *
 * @sample samples.streams.Streams.longStreamAsSequence
 */
@SinceKotlin("1.2")
public fun LongStream.asSequence(): Sequence = Sequence { iterator() }

/**
 * Creates a [Sequence] instance that wraps the original stream iterating through its elements.
 *
 * @sample samples.streams.Streams.doubleStreamAsSequence
 */
@SinceKotlin("1.2")
public fun DoubleStream.asSequence(): Sequence = Sequence { iterator() }

/**
 * Creates a sequential [Stream] instance that produces elements from the original sequence.
 *
 * @sample samples.streams.Streams.sequenceAsStream
 */
@SinceKotlin("1.2")
public fun  Sequence.asStream(): Stream =
    StreamSupport.stream({ Spliterators.spliteratorUnknownSize(iterator(), Spliterator.ORDERED) }, Spliterator.ORDERED, false)

/**
 * Returns a [List] containing all elements produced by this stream.
 *
 * @sample samples.streams.Streams.streamToList
 */
@SinceKotlin("1.2")
public fun  Stream.toList(): List = collect(Collectors.toList())

/**
 * Returns a [List] containing all elements produced by this stream.
 *
 * @sample samples.streams.Streams.intStreamToList
 */
@SinceKotlin("1.2")
public fun IntStream.toList(): List = toArray().asList()

/**
 * Returns a [List] containing all elements produced by this stream.
 *
 * @sample samples.streams.Streams.longStreamToList
 */
@SinceKotlin("1.2")
public fun LongStream.toList(): List = toArray().asList()

/**
 * Returns a [List] containing all elements produced by this stream.
 *
 * @sample samples.streams.Streams.doubleStreamToList
 */
@SinceKotlin("1.2")
public fun DoubleStream.toList(): List = toArray().asList()