Skip to content

Add comment to XContentBuilder.toString() #13809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 3, 2024
Merged

Add comment to XContentBuilder.toString() #13809

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17f01d1
Add comment to XContentBuilder.toString
chishui May 24, 2024
5cc0a04
Fix typo
chishui May 24, 2024
e7e736e
Merge branch 'opensearch-project:main' into main
chishui Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions libs/core/src/main/java/org/opensearch/core/xcontent/XContentBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ public static XContentBuilder builder(XContent xContent, Set<String> includes, S

/**
* Returns a string representation of the builder (only applicable for text based xcontent).
* Note: explicitly or implicitly (from debugger) calling toString() could cause XContentBuilder
* to close which is a side effect done by @see BytesReference#bytes().
* Trying to write more contents after toString() will cause NPE. Use it with caution.
*/
@Override
public String toString() {
Expand Down