Return an empty collection instead of null#2530
Merged
sugmanue merged 2 commits intosmithy-lang:mainfrom Feb 19, 2025
Merged
Conversation
The method `get<MemberName>OrEmpty()` for collections, either lists or maps, was supposed to return an empty collection when the collection was not set, instead of null, but somehow we missed to add this expected behavior. This change fixes this, if the collection was not set we return either `Collections.emptyList()` or `Collections.emptyMap()` depending on the collection type instead of `null`. The user can still find whether the value was set by using the `Optional<...> get<MemberName>()` variant that returns en empty optional when the collection was not set.
haydenbaker
reviewed
Feb 19, 2025
Comment on lines
148
to
149
| Collections.class, | ||
| isListShape ? "List" : "Map")); |
Contributor
There was a problem hiding this comment.
Could you do just Collections.emptyList()/Collections.emptyMap() instead of having to interpolate with empty? It would be a tad clearer, but no big deal.
Contributor
Author
There was a problem hiding this comment.
I guess we can, but we need to branch somewhere. What about spelling emptyList and emptyMap instead of just List and Map. That might be clearer.
haydenbaker
approved these changes
Feb 19, 2025
sugmanue
commented
Feb 19, 2025
...it-codegen/src/main/java/software/amazon/smithy/traitcodegen/generators/GetterGenerator.java
Outdated
Show resolved
Hide resolved
…tcodegen/generators/GetterGenerator.java
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
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.
Background
The method
get<MemberName>OrEmpty()for collections, either lists or maps, was supposed to return an empty collection when the collection was not set, instead of null, but somehow we missed to add this expected behavior. This change fixes this, if the collection was not set we return eitherCollections.emptyList()orCollections.emptyMap()depending on the collection type instead ofnull. The user can still find whether the value was set by using theOptional<...> get<MemberName>()variant that returns en empty optional when the collection was not set.Testing
Validated the generated code. We don't currently have asserts for the generated code but only tests that asserts that everything compiles as expected. Asserting on the expected generated code would be good but can be added in a different change.
For the
structuretrait in the tests now the code generated look like this for the membersfieldDandfieldE.Links
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.