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

8022797: Clarify spliterator characteristics for collections containing no elements

Browse Source 
Reviewed-by: alanb, mduigou
This commit is contained in:
Paul Sandoz 2013-08-13 11:16:37 +02:00
parent ea67b80891
commit e77f64d8dd
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
jdk/src/share/classes/java/util/Collection.java
View File

@ -504,7 +504,10 @@ public interface Collection<E> extends Iterable<E> {
* *
* <p>The returned {@code Spliterator} must report the characteristic * <p>The returned {@code Spliterator} must report the characteristic
* {@link Spliterator#SIZED}; implementations should document any additional * {@link Spliterator#SIZED}; implementations should document any additional
* characteristic values reported by the returned Spliterator. * characteristic values reported by the returned spliterator. If
* this collection contains no elements then the returned spliterator is
* only required to report {@link Spliterator#SIZED} and is not required to
* report additional characteristic values (if any).
* *
* <p>The default implementation should be overridden by subclasses that * <p>The default implementation should be overridden by subclasses that
* can return a more efficient spliterator. In order to * can return a more efficient spliterator. In order to
@ -535,6 +538,14 @@ public interface Collection<E> extends Iterable<E> {
* The returned {@code Spliterator} additionally reports * The returned {@code Spliterator} additionally reports
* {@link Spliterator#SUBSIZED}. * {@link Spliterator#SUBSIZED}.
* *
* <p>If a spliterator covers no elements then the reporting of additional
* characteristic values, beyond that of {@code SIZED} and {@code SUBSIZED},
* does not aid clients to control, specialize or simplify computation.
* However, this does enable shared use of an immutable and empty
* spliterator instance (see {@link Spliterators#emptySpliterator()}) for
* empty collections, and enables clients to determine if such a spliterator
* covers no elements.
*
* @return a {@code Spliterator} over the elements in this collection * @return a {@code Spliterator} over the elements in this collection
* @since 1.8 * @since 1.8
*/ */