stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8020061: Clarify reporting characteristics between splits

Browse Source 
Reviewed-by: alanb, chegar
This commit is contained in:
Paul Sandoz 2013-10-09 15:19:56 +02:00
parent f36ff9e467
commit ad959161e4
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
jdk/src/share/classes/java/util/Spliterator.java
View File

@ -414,13 +414,19 @@ public interface Spliterator<T> {
* #ORDERED}, {@link #DISTINCT}, {@link #SORTED}, {@link #SIZED}, * #ORDERED}, {@link #DISTINCT}, {@link #SORTED}, {@link #SIZED},
* {@link #NONNULL}, {@link #IMMUTABLE}, {@link #CONCURRENT}, * {@link #NONNULL}, {@link #IMMUTABLE}, {@link #CONCURRENT},
* {@link #SUBSIZED}. Repeated calls to {@code characteristics()} on * {@link #SUBSIZED}. Repeated calls to {@code characteristics()} on
* a given spliterator should always return the same result. * a given spliterator, prior to or in-between calls to {@code trySplit},
* should always return the same result.
* *
* <p>If a Spliterator reports an inconsistent set of * <p>If a Spliterator reports an inconsistent set of
* characteristics (either those returned from a single invocation * characteristics (either those returned from a single invocation
* or across multiple invocations), no guarantees can be made * or across multiple invocations), no guarantees can be made
* about any computation using this Spliterator. * about any computation using this Spliterator.
* *
* @apiNote The characteristics of a given spliterator before splitting
* may differ from the characteristics after splitting. For specific
* examples see the characteristic values {@link #SIZED}, {@link #SUBSIZED}
* and {@link #CONCURRENT}.
*
* @return a representation of characteristics * @return a representation of characteristics
*/ */
int characteristics(); int characteristics();