Deprecate buildStruct() in favor of idiomatic ionStructOf() overloads #99
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
rmarrowstone
approved these changes
Jul 25, 2024
| billiards: 30, | ||
| pingPong: 200, | ||
| } | ||
| val expected = ionStructOf { |
| @@ -45,24 +45,32 @@ public interface MutableStructFields : MutableCollection<StructField> { | |||
| */ | |||
| public fun add(fieldName: String, value: IonElement): Boolean | |||
|
|
|||
| /** Adds the given field to the collection. The collection may have multiple fields with the same name. | |||
| /** | |||
Merged
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.
Issue #, if available:
None
Description of changes:
It was brought to my attention that the
buildStruct()function, when used from Java, requires the lambda expression to returnUnit.INSTANCE, which is really ugly for Java consumers of this library.I've marked the
buildStruct()function as deprecated, and replaced it withionStructOf()overloads—one for Java that acceptsConsumer<MutableStructFields>and one that is hidden from Java that acceptsMutableStructFields.() -> Unit.While I was making these changes, I discovered that the package directive in the "demo" test cases did not match the file location, so I fixed those as well.
I also fixed some doc comments in
MutableStructFields.Finally, I also realized that
MutableStructFieldswould be a little nicer to use from Java if it was a proper builder class (i.e. with methods that returnthis). I've created #98 because I don't know whether it's worth adding yet another way to create a struct, and completely replacingMutableStructFieldswould be a breaking change.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.