xyz.hotchpotch.util.stream

クラス ZippedStream

java.lang.Object

xyz.hotchpotch.util.stream.ZippedStream

public class ZippedStream
extends java.lang.Object

2つのソースストリームの要素をペアリングして得られる要素をソースとする順次ストリームを提供します。

関連項目:

of(Stream, Stream)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static <T,U> java.util.stream.Stream<Pair<T,U>>	of(java.util.stream.Stream<? extends T> stream1, java.util.stream.Stream<? extends U> stream2) 2つのソースストリームの要素をペアリングして得られる要素をソースとする順次ストリームを生成します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

of

public static <T,U> java.util.stream.Stream<Pair<T,U>> of(java.util.stream.Stream<? extends T> stream1,
                                                          java.util.stream.Stream<? extends U> stream2)

2つのソースストリームの要素をペアリングして得られる要素をソースとする順次ストリームを生成します。
例を示します。

• ソースストリーム1 : 1, 2, 3, ...
• ソースストリーム2 : "a", "b", "c", ...
• 生成されるストリーム : (1, "a"), (2, "b"), (3, "c"), ...

生成されるストリームの長さは、2つのソースストリームの短い方に合わせて切り詰められます。 2つのソースストリームがともに無限ストリームの場合、生成されるストリームも無限ストリームになります。

2つのソースストリームがともに順序付けされている場合、生成されるストリームも順序付けされ、その要素は決定論的になります。
反対に、2つのソースストリームのいずれかまたは両方が順序付けされていない場合、生成されるストリームは順序付けされず、 その要素の値および並び順は非決定論的になります。 例えば、ソースストリーム1が順序付けされていない場合、(1, "a"), (2, "b"), (3, "c"), ... というストリームのみならず、 (2, "a"), (3, "b"), (1, "c"), ... というストリームも生成され得ます。これらはいずれも正当な結果とみなされます。 このことが好ましくない場合は、Stream.sorted() 等により得られる順序付けされたストリームをソースとするようにしてください。

生成されるストリームは、2つのソースストリームに遅延バインディングでバインドします。 従って、ソースストリーム自体も遅延バインディングであり、かつ、生成されるストリームに対して終端操作が開始される前までに行われたものであれば、 大元のソースに対する変更は生成されるストリームの要素に反映されます。
但し、2つのソースストリームに対するパラメータチェックによる例外は、構築時に直ちにスローされます。

このメソッドの実行により、新たなストリームの構築のためにソースストリームに対する終端操作が行われ、ソースストリームを再利用することはできなくなります。 但し、新たなストリームに対する終端操作が行われるまで、大元のソースが消費されることはありません。

終端操作開始後に大元のソースに対する構造的干渉が検出された場合の動作ポリシーは、ソースストリームのそれに従います。 すなわち、ソースストリームがフェイル・ファストであれば、生成されるストリームもフェイル・ファストになります。

注意： 新たなストリームは、2つのソースストリームから BaseStream.spliterator() により得られる Spliterator を介して構築されます。 従って、大元のソースがスレッドセーフであっても、そのソースの反復操作を行う際に手動で同期をとる必要がある場合は、 生成されたストリームのストリーム・パイプラインにおける大元のソースに対する操作は、スレッドセーフにはなりません。
具体的な例として、次のコードでは ConcurrentModificationException がスローされて処理が失敗します。

    List<Integer> threadSafeList = Collections.synchronizedList(new ArrayList<>(Arrays.asList(1, 2, 3)));
    Stream<Integer> stream1 = threadSafeList.stream();
    Stream<String> stream2 = Arrays.asList("a", "b", "c", "d", "e").stream();
    
    ZippedStream.of(stream1, stream2)
            .peek(p -> threadSafeList.add(p.m1() + 3))    // ここで例外が発生する。
            .forEach(Pair::toString);
 

threadSafeList はスレッドセーフですが、それに対する反復処理に際しては手動で同期をとる必要があります。 上の例ではそれがなされないまま threadSafeList に対する更新操作を行っているため、例外が発生します。
詳細は Collections.synchronizedList(List) の説明を参照してください。


生成されるストリームに対するクローズ操作は、ソースストリームに対するクローズ操作と連動しません。 ソースストリームが入出力チャネルをソースとする場合は、ソースストリームに対して個別にクローズ操作を行ってください。

型パラメータ:

T - ソースストリーム1の要素の型

U - ソースストリーム2の要素の型

パラメータ:

stream1 - ソースストリーム1

stream2 - ソースストリーム2

戻り値:

2つのソースストリームの要素をペアリングして得られる要素をソースとする順次ストリーム

例外:

java.lang.NullPointerException - stream1、stream2 のいずれかが null の場合

java.lang.IllegalArgumentException - stream1 と stream2 が同一インスタンスの場合

関連項目:

Stream, Spliterator