archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 15:24:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8151531: Add notes to BaseStream.spliterator/iterator docs regarding them being escape hatches

Browse source 
Reviewed-by: psandoz
This commit is contained in:
Viktor Klang 2023-05-10 16:29:34 +00:00 • committed by Paul Sandoz
parent 0198afca3a
commit 8a95020ab6
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/java.base/share/classes/java/util/stream/BaseStream.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -69,6 +69,11 @@ public interface BaseStream<T, S extends BaseStream<T, S>>
* <p>This is a <a href="package-summary.html#StreamOps">terminal
* operation</a>.
*
* @apiNote
* This operation is provided as an "escape hatch" to enable
* arbitrary client-controlled pipeline traversals in the event that the
* existing operations are not sufficient to the task.
*
* @return the element iterator for this stream
*/
Iterator<T> iterator();
@ -79,6 +84,11 @@ public interface BaseStream<T, S extends BaseStream<T, S>>
* <p>This is a <a href="package-summary.html#StreamOps">terminal
* operation</a>.
*
* @apiNote
* This operation is provided as an "escape hatch" to enable
* arbitrary client-controlled pipeline traversals in the event that the
* existing operations are not sufficient to the task.
*
* <p>
* The returned spliterator should report the set of characteristics derived
* from the stream pipeline (namely the characteristics derived from the