# HG changeset patch # User psandoz # Date 1381324796 -7200 # Node ID 66fd18be6993dda8256ab41fa8169174d91fa85c # Parent cd866b3875d8f1f819fbbea71861f31115763f40 8020061: Clarify reporting characteristics between splits Reviewed-by: alanb, chegar diff -r cd866b3875d8 -r 66fd18be6993 jdk/src/share/classes/java/util/Spliterator.java --- a/jdk/src/share/classes/java/util/Spliterator.java Wed Oct 09 10:48:44 2013 +0100 +++ b/jdk/src/share/classes/java/util/Spliterator.java Wed Oct 09 15:19:56 2013 +0200 @@ -414,13 +414,19 @@ * #ORDERED}, {@link #DISTINCT}, {@link #SORTED}, {@link #SIZED}, * {@link #NONNULL}, {@link #IMMUTABLE}, {@link #CONCURRENT}, * {@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. * *

If a Spliterator reports an inconsistent set of * characteristics (either those returned from a single invocation * or across multiple invocations), no guarantees can be made * 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 */ int characteristics();