From 8aae81b484e2bf00d68a6a68623d417846dc913f Mon Sep 17 00:00:00 2001
From: Paul Sandoz <psandoz@openjdk.org>
Date: Mon, 2 Feb 2015 14:18:54 +0100
Subject: [PATCH] 8048689: Clarify documentation on BaseStream.spliterator
Reviewed-by: lancea, chegar
---
.../share/classes/java/util/stream/BaseStream.java | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/jdk/src/java.base/share/classes/java/util/stream/BaseStream.java b/jdk/src/java.base/share/classes/java/util/stream/BaseStream.java
index 61e74867a19..0328b25cafd 100644
--- a/jdk/src/java.base/share/classes/java/util/stream/BaseStream.java
+++ b/jdk/src/java.base/share/classes/java/util/stream/BaseStream.java
@@ -79,6 +79,14 @@ public interface BaseStream<T, S extends BaseStream<T, S>>
* <p>This is a <a href="package-summary.html#StreamOps">terminal
* operation</a>.
*
+ * <p>
+ * The returned spliterator should report the set of characteristics derived
+ * from the stream pipeline (namely the characteristics derived from the
+ * stream source spliterator and the intermediate operations).
+ * Implementations may report a sub-set of those characteristics. For
+ * example, it may be too expensive to compute the entire set for some or
+ * all possible stream pipelines.
+ *
* @return the element spliterator for this stream
*/
Spliterator<T> spliterator();