Bson javadoc improvements #1883
Open
Conversation
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
Fixed no comment warning in BinaryVector Improved BsonBinary asUuid documentation Improved BsonBinarySubType isUuid documentation JAVA-6086
strogiyotec
reviewed
Feb 9, 2026
| * @see BsonBinarySubType | ||
| * @since 3.9 | ||
| */ | ||
| public UUID asUuid() { |
Contributor
There was a problem hiding this comment.
should we change the method signature to reflect the throws documentation ?
UUID asUuid() throws BsonInvalidOperationException
Member
Author
There was a problem hiding this comment.
Its a good point, however, it would introduce a new convention. For runtime errors we generally don't use checked exception patterns in the driver.
| * {@link UuidRepresentation#JAVA_LEGACY}. | ||
| * @since 3.9 | ||
| */ | ||
| public UUID asUuid(final UuidRepresentation uuidRepresentation) { |
Contributor
There was a problem hiding this comment.
same here should we add throws to method signature ?
https://github.com/mongodb/mongo-java-driver/pull/1883/changes#r2783802952
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixed no comment warning in BinaryVector
Improved BsonBinary asUuid documentation
Improved BsonBinarySubType isUuid documentation
JAVA-6086