Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.x: Ensure delegating operator overloads list all relevant @throws too in their Javadocs #6829

Closed
6 tasks done
akarnokd opened this issue Jan 9, 2020 · 0 comments · Fixed by #6860
Closed
6 tasks done

Comments

@akarnokd
Copy link
Member

akarnokd commented Jan 9, 2020

The current ParamValidationNaming can only check explicit argument validation (i.e., the method body lists requireNonNull or verifyPositive) but not overloads delegating to those methods thus lacking the explicit argument validation themselves.

I don't think this can be automated, therefore, each base reactive class' source should be manually examined and expanded with the missing @throws declaration:

  • Flowable
  • Observable
  • Maybe
  • Single
  • Completable
  • ParallelFlowable

(There is currently an Observable cleanup PR in the works, please wait for it before doing this issue.)

Edit

Perhaps checking if the typical method parameter names, such as bufferSize, prefetch, capacityHint, source*, mapper, predicate, etc. appear in @throws declaration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant