Improve JsonAdapter documentation and tests
#2442
Merged
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
1 task
Existing test `JsonAdapterNullSafeTest` had misleading comments; while it did in the end detect if null had not been handled correctly, that only worked because the field `JsonAdapterFactory.recursiveCall` is static and one test method therefore affected the state of the other test method. If the test methods were run separately in different test runs, they would not have detected if null was handled correctly, because the factory would not have returned null.
Marcono1234
force-pushed
the
marcono1234/JsonAdapter-doc-adapter-creation
branch
from
541d138
to
e0ebdfa
Compare
Marcono1234
changed the title
JsonAdapter creates adapter instances & add testsJsonAdapter documentation and tests
tibor-universe
pushed a commit
to getuniverse/gson
that referenced
this pull request
Sep 14, 2024
* Document how `JsonAdapter` creates adapter instances & add tests * Extend `JsonAdapter.nullSafe()` documentation * Improve test for JsonAdapter factory returning null Existing test `JsonAdapterNullSafeTest` had misleading comments; while it did in the end detect if null had not been handled correctly, that only worked because the field `JsonAdapterFactory.recursiveCall` is static and one test method therefore affected the state of the other test method. If the test methods were run separately in different test runs, they would not have detected if null was handled correctly, because the factory would not have returned null. * Extend JsonAdapter nullSafe test * Extend test
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.
Purpose
Improve
@JsonAdapterdocumentation and tests, especially regarding:@JsonAdaptercreates instancesJsonAdapter.nullSafeChecklist
null@since $next-version$(
$next-version$is a special placeholder which is automatically replaced during release)TestCase)mvn clean verify javadoc:jarpasses without errors