RFR 8131052 Documentation of AbstractSpliterator refers to forEach rather than forEachRemaining

[Paul Sandoz]

On Jul 16, 2015, at 12:07 PM, Daniel Fuchs <daniel.fuchs at oracle.com> wrote:

> On 16/07/15 12:00, Daniel Fuchs wrote:
>> On 13/07/15 11:19, Paul Sandoz wrote:
>>> Hi
>>> 
>>> Stefan, thanks.
>>> 
>>> See below for a patch to the documentation of all abstract spliterators.
>> 
>> Looks good to me Paul.
> 
> Sorry - re reading my mail I see that you have an extreneous '}'
> at the three last places - just after the closing ')':

Thanks, fixed,
Paul.

> 
> 
> >> +     * {@link #forEachRemaining(java.util.function.IntConsumer)}
> >> forEachRemaining}
> >> +     * if it can provide a more performant implementation.
> 
> 
> >> +     * {@link #forEachRemaining(java.util.function.LongConsumer)}
> >> forEachRemaining}
> >> +     * if it can provide a more performant implementation.
> 
> 
> >> +     * {@link #forEachRemaining(java.util.function.DoubleConsumer)}
> >> forEachRemaining}
> >> +     * if it can provide a more performant implementation.
> 
> -- daniel
> 
>> 
>> best regards,
>> 
>> -- daniel
>> 
>>> 
>>> Paul.
>>> 
>>> diff -r a3175de2e354
>>> src/java.base/share/classes/java/util/Spliterators.java
>>> --- a/src/java.base/share/classes/java/util/Spliterators.java    Tue
>>> Jun 09 07:10:03 2015 +0100
>>> +++ b/src/java.base/share/classes/java/util/Spliterators.java    Mon
>>> Jul 13 11:16:24 2015 +0200
>>> @@ -1235,8 +1235,8 @@
>>>       * <p>An extending class need only
>>>       * implement {@link #tryAdvance(java.util.function.Consumer)
>>> tryAdvance}.
>>>       * The extending class should override
>>> -     * {@link #forEachRemaining(java.util.function.Consumer) forEach}
>>> if it can
>>> -     * provide a more performant implementation.
>>> +     * {@link #forEachRemaining(java.util.function.Consumer)
>>> forEachRemaining}
>>> +     * if it can provide a more performant implementation.
>>>       *
>>>       * @apiNote
>>>       * This class is a useful aid for creating a spliterator when it
>>> is not
>>> @@ -1358,8 +1358,8 @@
>>>       * <p>To implement a spliterator an extending class need only
>>>       * implement {@link #tryAdvance(java.util.function.IntConsumer)}
>>>       * tryAdvance}.  The extending class should override
>>> -     * {@link #forEachRemaining(java.util.function.IntConsumer)}
>>> forEach} if it
>>> -     * can provide a more performant implementation.
>>> +     * {@link #forEachRemaining(java.util.function.IntConsumer)}
>>> forEachRemaining}
>>> +     * if it can provide a more performant implementation.
>>>       *
>>>       * @apiNote
>>>       * This class is a useful aid for creating a spliterator when it
>>> is not
>>> @@ -1468,8 +1468,8 @@
>>>       * <p>To implement a spliterator an extending class need only
>>>       * implement {@link #tryAdvance(java.util.function.LongConsumer)}
>>>       * tryAdvance}.  The extending class should override
>>> -     * {@link #forEachRemaining(java.util.function.LongConsumer)}
>>> forEach} if it
>>> -     * can provide a more performant implementation.
>>> +     * {@link #forEachRemaining(java.util.function.LongConsumer)}
>>> forEachRemaining}
>>> +     * if it can provide a more performant implementation.
>>>       *
>>>       * @apiNote
>>>       * This class is a useful aid for creating a spliterator when it
>>> is not
>>> @@ -1578,8 +1578,8 @@
>>>       * <p>To implement a spliterator an extending class need only
>>>       * implement {@link #tryAdvance(java.util.function.DoubleConsumer)}
>>>       * tryAdvance}.  The extending class should override
>>> -     * {@link #forEachRemaining(java.util.function.DoubleConsumer)}
>>> forEach} if
>>> -     * it can provide a more performant implementation.
>>> +     * {@link #forEachRemaining(java.util.function.DoubleConsumer)}
>>> forEachRemaining}
>>> +     * if it can provide a more performant implementation.
>>>       *
>>>       * @apiNote
>>>       * This class is a useful aid for creating a spliterator when it
>>> is not
>>> 
>>> On Jul 12, 2015, at 11:56 AM, Stefan Zobel <spliterator at gmail.com> wrote:
>>> 
>>>> Hi all,
>>>> 
>>>> 
>>>> I just noticed some typos in the
>>>> Spliterators.Abstract(Double/Int/Long)Spliterator Javadoc:
>>>> 
>>>> a) The forEachRemaining link label is "forEach" instead of
>>>> "forEachRemaining" in all AbstractSpliterators.
>>>> 
>>>> b) The primitive AbstractSpliterators Javadoc has a surplus "}" just
>>>> before
>>>> the tryAdvance and forEach link labels.
>>>> 
>>>> 
>>>> 
>>>> Stefan
>>> 
>> 
>