Guarantee that JsonElement.toString() produces JSON - #2659
Merged
eamonnmcmanus merged 5 commits intoMay 18, 2024
Conversation
9 tasks
eamonnmcmanus
approved these changes
May 18, 2024
tibor-universe
pushed a commit
to getuniverse/gson
that referenced
this pull request
Sep 14, 2024
* Extend `JsonElement` documentation * Add space to JsonParser code example * Guarantee that `JsonElement.toString()` produces JSON * Refer to `JsonElement` documentation from subclasses
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.
(Depends on #2654)
Purpose
Resolves #591
Resolves #1439
Description
As pointed out in #591 the result of
JsonElement.toString()is currently unspecified. However, many users and also Gson's own unit tests assume that the output is valid JSON.Changing the
JsonElement.toString()behavior would likely be backward incompatible. Therefore it seems reasonable to guarantee in the documentation thattoString()produces JSON, which is already the case implementation-wise.Checklist
This is automatically checked by
mvn verify, but can also be checked on its own usingmvn spotless:check.Style violations can be fixed using
mvn spotless:apply; this can be done in a separate commit to verify that it did not cause undesired changes.null@since $next-version$(
$next-version$is a special placeholder which is automatically replaced during release)TestCase)mvn clean verify javadoc:jarpasses without errors