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

Add nullability annotation based on JavaDoc #637

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

schnapster
Copy link

@schnapster schnapster commented May 21, 2024

This morning I was greeted by a nice error in our production service:

java.lang.NullPointerException: getCookies(...) must not be null

Oof.

The docs of HttpServletRequest#getCookies() clearly state it may return null, however its 2024 and

  • noone reads docs, speaking strictly for myself, anyways =)
  • since early 2022, Jakarta Annotations v2.1 was released, and along with it nullability annotations are officially available in the Jakarta ecosystem

I have therefore given the JavaDocs of Jakarta Servlet a cursory look and implemented nullability annotations where I deemed them sufficiently indicated.

This should help all devs using modern IDEs and modern compilers (e.g. Kotlin): they will see warnings when accessing nullable values without explicit null checks.

I've probably missed some places, but I hope this PR by itself already provides enough value to the project to be merged.

Please let me know with any feedback or anything missing.

@schnapster schnapster force-pushed the feature/nullability-annotations branch from e9d1951 to 2ed3a24 Compare May 23, 2024 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant