Improve BlockingIterable javadoc #2010
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: `BlockingIterable` and `BlockingIterator` methods can throw `InterruptedException` using the sneaky-throw mechanism. The reason for it is that implementations rely on `BlockingQueue` which may be interrupted. However, as `BlockingIterator` extends `Iterator` from the JDK, its' method signatures don't list any checked exception. Therefore it would be inconsistent to have some methods declare checked exceptions, while the overridden ones not. Modification: Add javadoc notes to all methods that can throw `InterruptedException` to `BlockingIterable` and `BlockingIterator`. Result: The runtime behavior is better described via javadoc.
chemicL
requested review from
bondolo,
tkountis,
idelpivnitskiy and
Scottmitch
bondolo
approved these changes
Dec 10, 2021
idelpivnitskiy
approved these changes
Dec 10, 2021
idelpivnitskiy
pushed a commit
that referenced
this pull request
Dec 14, 2021
Motivation: `BlockingIterable` and `BlockingIterator` methods can throw `InterruptedException` using the sneaky-throw mechanism. The reason for it is that implementations rely on `BlockingQueue` which may be interrupted. However, as `BlockingIterator` extends `Iterator` from the JDK, its' method signatures don't list any checked exception. Therefore it would be inconsistent to have some methods declare checked exceptions, while the overridden ones not. Modification: Add javadoc notes to all methods that can throw `InterruptedException` to `BlockingIterable` and `BlockingIterator`. Result: The runtime behavior is better described via javadoc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
BlockingIterableandBlockingIteratormethods can throwInterruptedExceptionusing the sneaky-throw mechanism. The reason forit is that implementations rely on
BlockingQueuewhich may beinterrupted. However, as
BlockingIteratorextendsIteratorfrom theJDK, its' method signatures don't list any checked exception. Therefore
it would be inconsistent to have some methods declare checked
exceptions, while the overridden ones not.
Modification:
Add javadoc notes to all methods that can throw
InterruptedExceptionto
BlockingIterableandBlockingIterator.Result:
The runtime behavior is better described via javadoc.