docs: replace com.vaadin.hilla.Nonnull usages #4155
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
github-actions
bot
added
the
Language unchecked
sissbruecker
removed
the
Language unchecked
taefi
reviewed
Feb 27, 2025
There was a problem hiding this comment.
LGTM, but also updated the recommendation of Vaadin about using JSpecify NonNull and Nullable annotations. Asking @cromoteca for a second review.
taefi
reviewed
Feb 28, 2025
taefi
reviewed
Feb 28, 2025
taefi
reviewed
Feb 28, 2025
platosha
reviewed
Mar 4, 2025
|
|
||
| You can use any annotation that has the name `nonnull` (case-insensitive). Below are examples of this: | ||
| While the usage of any annotation that has the name `nonnull` (case-insensitive) is supported, Vaadin recommends using the `org.jspecify.annotations.NonNull`. Below are some examples of other supported `nonnull` annotations: | ||
|
|
There was a problem hiding this comment.
Let's also remove the bullet list below. It's not up-to-date and brings more confusion than value.
There was a problem hiding this comment.
I addressed this a while ago, so it could get merged IMO, unless there's something more to address.
cromoteca
requested changes
Mar 17, 2025
cromoteca
requested changes
Mar 19, 2025
| @@ -15,16 +15,12 @@ Types that are set as _non_nullable_ are in essence required. Whereas types that | |||
| - A collection accepts `null`, unless the collection item type is primitive. | |||
| - A map accepts `null`, unless the collection item type is primitive. | |||
|
|
|||
| Any of these nullable types can be made non-nullable by applying a `@Nonnull` annotation. | |||
| Any of these nullable types can be made non-nullable by applying a `@NonNull` annotation. Vaadin recommends using the `@org.jspecify.annotations.NonNull`. However, the list of all supported annotations is as follows: | |||
There was a problem hiding this comment.
Suggested change
| Any of these nullable types can be made non-nullable by applying a `@NonNull` annotation. Vaadin recommends using the `@org.jspecify.annotations.NonNull`. However, the list of all supported annotations is as follows: | |
| Any of these nullable types can be made non-nullable by applying a `@NonNull` annotation. Vaadin recommends using `@org.jspecify.annotations.NonNull`. The full list of supported annotations is as follows: |
|
|
||
| By default, the following annotation is supported: `org.springframework.lang.NonNullApi`. | ||
|
|
||
| To make any type nullable, you must add `@Nullable` annotation to it. | ||
| To make any type nullable, you must add `@Nullable` annotation to it. Vaadin recommends using the `@org.jspecify.annotations.Nullable`. However, the list of all supported annotations is as follows: |
There was a problem hiding this comment.
Suggested change
| To make any type nullable, you must add `@Nullable` annotation to it. Vaadin recommends using the `@org.jspecify.annotations.Nullable`. However, the list of all supported annotations is as follows: | |
| To make any type nullable, you must add a `@Nullable` annotation to it. Vaadin recommends using `@org.jspecify.annotations.Nullable`. The full list of supported annotations is as follows: |
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.
Fixes #4156
Fixes vaadin/hilla#3350
Replaces usages of the deprecated
com.vaadin.hilla.Nonnullannotation in examples with the jspecify variant.