Finish annotating some classes for nullness. #71
Conversation
Parts of this are relevant to typetools/checker-framework#3197 Other parts are a followup to typetools/checker-framework#3063 Merge with typetools/checker-framework#3549
| @@ -509,7 +512,8 @@ public int remainingCapacity() { | |||
| * @param o element to be removed from this queue, if present | |||
| * @return {@code true} if this queue changed as a result of the call | |||
| */ | |||
| public boolean remove(@Nullable Object o) { | |||
| @CFComment("probably accepts null in practice, but docs at best imply this") | |||
There was a problem hiding this comment.
It looks like typetools/checker-framework#3063 didn't touch this file. (That is, this annotation was there before that PR.) I'm not sure if that means that you hadn't looked at it at the time or that you found some reason to justify omitting @Nullable here.
Likewise for the other queues/deques in this PR.
| @@ -262,7 +264,7 @@ public int indexOf(@Nullable Object o) { | |||
| * {@code -1} if the element is not found. | |||
| * @throws IndexOutOfBoundsException if the specified index is negative | |||
| */ | |||
| public int indexOf(E e, int index) { | |||
| public int indexOf(@Nullable E e, int index) { | |||
There was a problem hiding this comment.
@Nullable here is pretty weird. It looks well justified to me by the contract (and implementation). However, I'm not sure how often callers would want to pass null here. I'm not sure if you'd want to leave @Nullable off for that reason.
| @@ -1478,15 +1483,15 @@ public boolean removeIf(Predicate<? super E> filter) { | |||
| /** | |||
| * @throws NullPointerException {@inheritDoc} | |||
| */ | |||
| public boolean removeAll(Collection<? extends @NonNull Object> c) { | |||
| public boolean removeAll(Collection<?> c) { | |||
There was a problem hiding this comment.
This takes us back to typetools/checker-framework#3197
removeAll and retainAll officially throw only if both:
- the argument throws on null queries
- the receiver contains nulls
In this case, the latter condition can't hold. So any call is safe.
Below is a different case: That collection can contain nulls, so the only provably safe argument is another collection that can contain nulls.
Parts of this are relevant to
typetools/checker-framework#3197
Other parts are a followup to
typetools/checker-framework#3063
Merge with typetools/checker-framework#3549