DaveAKing / guava-libraries

Automatically exported from code.google.com/p/guava-libraries
Apache License 2.0
0 stars 0 forks source link

Misleading comment in class Iterations.java #1671

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
In class Iterations.java, at line 980

Method: static <T> T pollNext(Iterator<T> iterator);
Currently has the following comment: 

/**
  * Deletes and returns the next value from the iterator, or returns
  * {@code defaultValue} if there is no such value.
*/

This is misleading as the implementation suggests that the given method returns 
null, if no value was found.
also, that method is annotated with @Nullable 
I'm aware that this method is package-visible and such it is not visible 
through API, so that's a minor issue..

Original issue reported on code.google.com by bi.i...@gmail.com on 16 Feb 2014 at 9:44

GoogleCodeExporter commented 9 years ago
Fixed internally; will be mirrored out shortly.

Original comment by lowas...@google.com on 18 Feb 2014 at 7:19

GoogleCodeExporter commented 9 years ago
This issue has been migrated to GitHub.

It can be found at https://github.com/google/guava/issues/<issue id>

Original comment by cgdecker@google.com on 1 Nov 2014 at 4:10

GoogleCodeExporter commented 9 years ago

Original comment by cgdecker@google.com on 3 Nov 2014 at 9:07