Spliterators

emptyDoubleSpliterator

static fun emptyDoubleSpliterator(): Spliterator.OfDouble!

Creates an empty Spliterator.OfDouble

The empty spliterator reports Spliterator#SIZED and Spliterator#SUBSIZED. Calls to java.util.Spliterator#trySplit() always return null.

emptyIntSpliterator

static fun emptyIntSpliterator(): Spliterator.OfInt!

Creates an empty Spliterator.OfInt

The empty spliterator reports Spliterator#SIZED and Spliterator#SUBSIZED. Calls to java.util.Spliterator#trySplit() always return null.

emptyLongSpliterator

static fun emptyLongSpliterator(): Spliterator.OfLong!

Creates an empty Spliterator.OfLong

The empty spliterator reports Spliterator#SIZED and Spliterator#SUBSIZED. Calls to java.util.Spliterator#trySplit() always return null.

emptySpliterator

static fun <T : Any!> emptySpliterator(): Spliterator<T>!

Creates an empty Spliterator

The empty spliterator reports Spliterator#SIZED and Spliterator#SUBSIZED. Calls to java.util.Spliterator#trySplit() always return null.

iterator

static fun <T : Any!> iterator(spliterator: Spliterator<out T>!): MutableIterator<T>!

Creates an Iterator from a Spliterator.

Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.

iterator

static fun iterator(spliterator: Spliterator.OfInt!): PrimitiveIterator.OfInt!

Creates an PrimitiveIterator.OfInt from a Spliterator.OfInt.

Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.

iterator

static fun iterator(spliterator: Spliterator.OfLong!): PrimitiveIterator.OfLong!

Creates an PrimitiveIterator.OfLong from a Spliterator.OfLong.

Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.

iterator

static fun iterator(spliterator: Spliterator.OfDouble!): PrimitiveIterator.OfDouble!

Creates an PrimitiveIterator.OfDouble from a Spliterator.OfDouble.

Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.

spliterator

static fun <T : Any!> spliterator(
    array: Array<Any!>!, 
    additionalCharacteristics: Int
): Spliterator<T>!

Creates a Spliterator covering the elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(Object[]).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.

spliterator

static fun <T : Any!> spliterator(
    array: Array<Any!>!, 
    fromIndex: Int, 
    toIndex: Int, 
    additionalCharacteristics: Int
): Spliterator<T>!

Creates a Spliterator covering a range of elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(Object[]).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.

spliterator

static fun spliterator(
    array: IntArray!, 
    additionalCharacteristics: Int
): Spliterator.OfInt!

Creates a Spliterator.OfInt covering the elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(int[]).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.

spliterator

static fun spliterator(
    array: IntArray!, 
    fromIndex: Int, 
    toIndex: Int, 
    additionalCharacteristics: Int
): Spliterator.OfInt!

Creates a Spliterator.OfInt covering a range of elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(int[], int, int).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.

spliterator

static fun spliterator(
    array: LongArray!, 
    additionalCharacteristics: Int
): Spliterator.OfLong!

Creates a Spliterator.OfLong covering the elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(long[]).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.

spliterator

static fun spliterator(
    array: LongArray!, 
    fromIndex: Int, 
    toIndex: Int, 
    additionalCharacteristics: Int
): Spliterator.OfLong!

Creates a Spliterator.OfLong covering a range of elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(long[], int, int).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report. (For example, if it is known the array will not be further modified, specify IMMUTABLE; if the array data is considered to have an encounter order, specify ORDERED). The method Arrays#spliterator(long[], int, int) can often be used instead, which returns a spliterator that reports SIZED, SUBSIZED, IMMUTABLE, and ORDERED.

spliterator

static fun spliterator(
    array: DoubleArray!, 
    additionalCharacteristics: Int
): Spliterator.OfDouble!

Creates a Spliterator.OfDouble covering the elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(double[]).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.

spliterator

static fun spliterator(
    array: DoubleArray!, 
    fromIndex: Int, 
    toIndex: Int, 
    additionalCharacteristics: Int
): Spliterator.OfDouble!

Creates a Spliterator.OfDouble covering a range of elements of a given array, using a customized set of spliterator characteristics.

This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays#spliterator(double[], int, int).

The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report. (For example, if it is known the array will not be further modified, specify IMMUTABLE; if the array data is considered to have an encounter order, specify ORDERED). The method Arrays#spliterator(long[], int, int) can often be used instead, which returns a spliterator that reports SIZED, SUBSIZED, IMMUTABLE, and ORDERED.

spliterator

static fun <T : Any!> spliterator(
    c: MutableCollection<out T>!, 
    characteristics: Int
): Spliterator<T>!

Creates a Spliterator using the given collection's java.util.Collection#iterator() as the source of elements, and reporting its java.util.Collection#size() as its initial size.

The spliterator is late-binding, inherits the fail-fast properties of the collection's iterator, and implements trySplit to permit limited parallelism.

spliterator

static fun <T : Any!> spliterator(
    iterator: MutableIterator<T>!, 
    size: Long, 
    characteristics: Int
): Spliterator<T>!

Creates a Spliterator using a given Iterator as the source of elements, and with a given initially reported size.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.

spliterator

static fun spliterator(
    iterator: PrimitiveIterator.OfInt!, 
    size: Long, 
    characteristics: Int
): Spliterator.OfInt!

Creates a Spliterator.OfInt using a given IntStream.IntIterator as the source of elements, and with a given initially reported size.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.

spliterator

static fun spliterator(
    iterator: PrimitiveIterator.OfLong!, 
    size: Long, 
    characteristics: Int
): Spliterator.OfLong!

Creates a Spliterator.OfLong using a given LongStream.LongIterator as the source of elements, and with a given initially reported size.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.

spliterator

static fun spliterator(
    iterator: PrimitiveIterator.OfDouble!, 
    size: Long, 
    characteristics: Int
): Spliterator.OfDouble!

Creates a Spliterator.OfDouble using a given DoubleStream.DoubleIterator as the source of elements, and with a given initially reported size.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.

spliteratorUnknownSize

static fun <T : Any!> spliteratorUnknownSize(
    iterator: MutableIterator<T>!, 
    characteristics: Int
): Spliterator<T>!

Creates a Spliterator using a given Iterator as the source of elements, with no initial size estimate.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.

spliteratorUnknownSize

static fun spliteratorUnknownSize(
    iterator: PrimitiveIterator.OfInt!, 
    characteristics: Int
): Spliterator.OfInt!

Creates a Spliterator.OfInt using a given IntStream.IntIterator as the source of elements, with no initial size estimate.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.

spliteratorUnknownSize

static fun spliteratorUnknownSize(
    iterator: PrimitiveIterator.OfLong!, 
    characteristics: Int
): Spliterator.OfLong!

Creates a Spliterator.OfLong using a given LongStream.LongIterator as the source of elements, with no initial size estimate.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.

spliteratorUnknownSize

static fun spliteratorUnknownSize(
    iterator: PrimitiveIterator.OfDouble!, 
    characteristics: Int
): Spliterator.OfDouble!

Creates a Spliterator.OfDouble using a given DoubleStream.DoubleIterator as the source of elements, with no initial size estimate.

The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.

Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.