docs: document IllegalArgumentException on URL setters#9707
Merged
Conversation
Add the missing `@throws IllegalArgumentException` doclet to Credits#setHref, SideNavItem#setPath and BreadcrumbsItem#setPath. These setters validate the URL scheme and throw, but the behavior was undocumented, unlike the other validating setters (e.g. Exporting#setUrl). Also add a `@see` reference to the matching setUnsafe* variant.
web-padawan
approved these changes
Jul 9, 2026
|
sissbruecker
pushed a commit
that referenced
this pull request
Jul 9, 2026
…5.2) (#9712) This PR cherry-picks changes from the original PR #9707 to branch 25.2. --- #### Original PR description > Add the missing `@throws IllegalArgumentException` doclet to Credits#setHref, SideNavItem#setPath and BreadcrumbsItem#setPath. These setters validate the URL scheme and throw, but the behavior was undocumented, unlike the other validating setters (e.g. Exporting#setUrl). Also add a `@see` reference to the matching setUnsafe* variant. > Co-authored-by: Marco Collovati <marco@vaadin.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add the missing
@throws IllegalArgumentExceptiondoclet to Credits#setHref, SideNavItem#setPath and BreadcrumbsItem#setPath. These setters validate the URL scheme and throw, but the behavior was undocumented, unlike the other validating setters (e.g. Exporting#setUrl). Also add a@seereference to the matching setUnsafe* variant.