Java8 series (three) Spliterator divided iterator

This article is reproduced from jdk8 Stream parsing 2 - Spliterator split iterator .

Outline

Our most common way to stream is generated collection.stream(), you point to open Stream()approach, he is by Collection the upper interface java8 two new features default method were realized.

    @Override
    default Spliterator<E> spliterator() {
        return Spliterators.spliterator(this, 0);
    }

    default Stream<E> stream() {
        return StreamSupport.stream(spliterator(), false);
    }

This involves a key point Spliterator : split iterator.

This paper describes Spliterator the role, most come from you do not want to read JavaDoc.

Spliterator It is a jdk8 very important concept. Inside the details are worth learning interesting.

Spliterator lengthy JavaDoc said what?

basic introduction

Spliterator A source (arrays, collections, IO flow, etc.) and the elements traverse partition classes.

By tryAdvance() individually traversal method, you can follow forEachRemaining() carried out by the method of bulk -by-block traversal. (Internal call or tryAdvance )

Spliterator There are similar Collector in characteristics , but they are represented by the hexadecimal.

SIZED: indicates a fixed size, Collection common
DISTINCT: de-duplication, Set common
SORTED: sequential SortedSet will use
and many more

Special version of the original type of

Dividing the original type specialized iterator is also provided, and Stream the like. Reduce operational boxing and unboxing

Way more efficient than the iterator Iterator traversal elements

Provide a more efficient method of iterative data.
Iterator The use of a combination of two methods need to call hasNext() and next() , at the same time there will be competition in the case of multi-threaded access, you need to synchronize.
Iterator divided Spliterator manner using the programming function, a method can only be done by the two operation functions. To avoid competition, it is tryAdvance() the method. We will be back on

Spliterator interface methods

tryAdvance()

Meanwhile done hasNext() and next() work.

/ ** 
* similar to ordinary Iterator, it will order a Spliterator an element in the implementation of action to use, and if there are other elements that you want to return to traverse true, otherwise false. 
* / 
Boolean tryAdvance (Consumer <? Super Action T>);

forEachRemaining()

是一个默认方法，对余下的元素进行操作，直到元素全部被遍历完
一般情况下会直接调用上面的tryAdvance() 方法，但是也可以根据需要进行重写。

/**
* 对余下的元素进行操作，直到元素全部被遍历完
* 如果源是有序的，遍历也是有序的
*/
default void forEachRemaining(Consumer<? super T> action) {
        do { } while (tryAdvance(action));
}

这里有一点很值得注意，方法体中的 do {} 是空的，这个是因为 tryAdvance() 方法本身就完成了两个操作 hasNext() 以及 next()，所以方法体中不需要有任何操作了。这个是函数式编程带来的好处。以及与命令式编程的区别。

trySplit()

尝试切分源来的 Spliterator，返回的是（注意！！！）返回的是 分割出来的那一部分 数据，原有的数据集将不再包含这部分数据集合。两者 没有交集。剩下的可以继续分割，也许不可以继续分割了。

举个例子，我原来有 100个元素，我通过 trySplit 切分出 30 个，作为一个新的 Spliterator分割迭代器 返回，原有的，就还剩下 70 个。

如果是原有数据集合是 ORDERD 的，分出来的也是有序的。
除非元素数量是无穷的，否则，最后一定会出现不能再分割的情况，这种情况下，返回的结果是 null。

Spliterator<T> trySplit();

estimateSize()

估算还剩下多少个元素需要遍历，不一定精确。
但是如果这个 Spliterator 是 SIZED，没有被遍历或者 split，或是 SUBSIZED的，没有被遍历，那么他这个值一定是准确的。

long estimateSize();

还有个与之相关的默认方法，就是利用这个特性。

default long getExactSizeIfKnown() {
    return (characteristics() & SIZED) == 0 ? -1L : estimateSize();
}

characteristics()

分割之前，返回的结果都是一致的
而分割之后，不保证一致

有一个默认方法用于判断 Spliterator 是否包含这个特性

default boolean hasCharacteristics(int characteristics) {
    return (characteristics() & characteristics) == characteristics;
}

getComparator

如果源是SORTED 类型的，且有比较器 Comparator 的话，则返回这个 Comparator，如果是SORTED 类型的，但是没有比较器，则返回 null , 除此之外，都抛出异常。

接口的默认方法里，就是抛出了异常。

default Comparator<? super T> getComparator() {
    throw new IllegalStateException();
}

Spliterator的8个Characteristics 特性

ORDERED

源的元素有序，tryAdvance ，forEachRemaining和 trySplit 都会保证有序的进行元素的处理。

需要注意 hashSet 这类 Collection 是不保证有序的
有ORDERED 特性的数据，在并发计算的时候客户端也要做顺序限制的保证

DISTINCT

太简单，唯一性。类似 Set 这样的传入集合会拥有这样的特性

SORTED

有这种特性的 Spliterator ，有一个特定的顺序。或者是所有元素都是可比较的，或者是有特定的比较器。

有 SORTED 一定会有 ORDERED

SIZED

有这种属性的 Spliterator 在遍历和分割之前，estimateSize() 返回的大小是固定的，并且是准确的。

NONNULL

不为 NULL, 大部分并发的集合，队列，Map 都可能会有这样的特性。

IMMUTABLE

不可变的。元素遍历期间不可以被添加，替换，删除（cannot be added, replaced, or removed），否则，应该抛出异常。

CONCURRENT

支持并发操作的。

顶层的 Spliterator 不可以 CONCURRENT 与 SIZED。这两者是相互冲突的。
但是分割之后的 Spliterator ，可能是 SIZED，顶层不能决定底层

SUBSIZED

该 Spliterator 和所有从它拆分出来的分割迭代器都是 SIZED 以及 SUBSIZED 的。
如果分割后，没有按照要求返回SIZED 以及 SUBSIZED 属性，那么操作是不被保证的，也就是结果不可预测。

这个属性和 SIZED 的区别就是， SIZED 不保证 SUBSIZED。而 SUBSIZED 会要求保证 SIZED

内部特化而做的函数式接口 (OfPrimitive)

除了上面的函数，以及特性，Spliterator 迭代器中，还有几个定义在内部的接口。

OfPrimitive 重载了（overloads）了 Spliterator 的方法。用于实现特化的分割迭代器。

overloads：参数列表不同，函数名相同，与返回值类型无关，与访问修饰符无关。

注意与 override 的区别

免责声明：
本文转自网络文章，转载此文章仅为个人收藏，分享知识，如有侵权，请联系博主进行删除。
原文作者：待葡萄嗖透
原文出处：http://movingon.cn/2017/05/02/jdk8-Stream-%E8%A7%A3%E6%9E%902-Spliterator%E5%88%86%E5%89%B2%E8%BF%AD%E4%BB%A3%E5%99%A8/