[PATCH] Incomplete JavaDoc for Collections.synchronizedXYZ

[Tagir F. Valeev]

Hello!

Thanks, looks good.

With best regards,
Tagir Valeev.

PS> Hi,

PS> I made some minor tweaks for consistency. This is the version i will push:

PS> http://cr.openjdk.java.net/~psandoz/jdk9/JDK-8141630-Collections-synchronized/webrev/src/java.base/share/classes/java/util/Collections.java.sdiff.html
PS> <http://cr.openjdk.java.net/~psandoz/jdk9/JDK-8141630-Collections-synchronized/webrev/src/java.base/share/classes/java/util/Collections.java.sdiff.html>

PS> Paul.

>> On 25 Oct 2015, at 10:29, Tagir F. Valeev <amaembo at gmail.com> wrote:
>> 
>> Hello!
>> 
>> Here's the patch. I updated JavaDoc for synchronizedSet,
>> synchronizedSortedSet, synchronizedNavigableSet, synchronizedList,
>> synchronizedMap, synchronizedSortedMap and synchronizedNavigableMap.
>> Hopefully my wording is correct (English is not my native language).
>> 
>> With best regards,
>> Tagir Valeev.
>> 
>> diff --git a/src/java.base/share/classes/java/util/Collections.java b/src/java.base/share/classes/java/util/Collections.java
>> --- a/src/java.base/share/classes/java/util/Collections.java
>> +++ b/src/java.base/share/classes/java/util/Collections.java
>> @@ -2090,7 +2090,8 @@
>>      * through the returned set.<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * set when iterating over it:
>> +     * set when traversing it via {@link Iterator}, {@link Spliterator}
>> +     * or {@link Stream}:
>>      * <pre>
>>      *  Set s = Collections.synchronizedSet(new HashSet());
>>      *      ...
>> @@ -2149,8 +2150,9 @@
>>      * through the returned sorted set (or its views).<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * sorted set when iterating over it or any of its {@code subSet},
>> -     * {@code headSet}, or {@code tailSet} views.
>> +     * sorted set when traversing it or any of its {@code subSet},
>> +     * {@code headSet}, or {@code tailSet} views via {@link Iterator},
>> +     * {@link Spliterator} or {@link Stream}:
>>      * <pre>
>>      *  SortedSet s = Collections.synchronizedSortedSet(new TreeSet());
>>      *      ...
>> @@ -2240,8 +2242,9 @@
>>      * accomplished through the returned navigable set (or its views).<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * navigable set when iterating over it or any of its {@code subSet},
>> -     * {@code headSet}, or {@code tailSet} views.
>> +     * navigable set when traversing it or any of its {@code subSet},
>> +     * {@code headSet}, or {@code tailSet} views via {@link Iterator},
>> +     * {@link Spliterator} or {@link Stream}:
>>      * <pre>
>>      *  NavigableSet s = Collections.synchronizedNavigableSet(new TreeSet());
>>      *      ...
>> @@ -2355,7 +2358,8 @@
>>      * through the returned list.<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * list when iterating over it:
>> +     * list when traversing it via {@link Iterator}, {@link Spliterator}
>> +     * or {@link Stream}:
>>      * <pre>
>>      *  List list = Collections.synchronizedList(new ArrayList());
>>      *      ...
>> @@ -2523,7 +2527,8 @@
>>      * through the returned map.<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * map when iterating over any of its collection views:
>> +     * map when traversing any of its collection views via {@link Iterator},
>> +     * {@link Spliterator} or {@link Stream}:
>>      * <pre>
>>      *  Map m = Collections.synchronizedMap(new HashMap());
>>      *      ...
>> @@ -2700,9 +2705,9 @@
>>      * through the returned sorted map (or its views).<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * sorted map when iterating over any of its collection views, or the
>> -     * collections views of any of its {@code subMap}, {@code headMap} or
>> -     * {@code tailMap} views.
>> +     * sorted map when traversing via {@link Iterator}, {@link Spliterator}
>> +     * or {@link Stream} any of its collection views, or the collections views
>> +     * of any of its {@code subMap}, {@code headMap} or {@code tailMap} views:
>>      * <pre>
>>      *  SortedMap m = Collections.synchronizedSortedMap(new TreeMap());
>>      *      ...
>> @@ -2797,9 +2802,9 @@
>>      * accomplished through the returned navigable map (or its views).<p>
>>      *
>>      * It is imperative that the user manually synchronize on the returned
>> -     * navigable map when iterating over any of its collection views, or the
>> -     * collections views of any of its {@code subMap}, {@code headMap} or
>> -     * {@code tailMap} views.
>> +     * navigable map when traversing via {@link Iterator}, {@link Spliterator}
>> +     * or {@link Stream} any of its collection views, or the collections views
>> +     * of any of its {@code subMap}, {@code headMap} or {@code tailMap} views:
>>      * <pre>
>>      *  NavigableMap m = Collections.synchronizedNavigableMap(new TreeMap());
>>      *      …