Skip to content

Commit

Permalink
Add comment to XContentBuilder.toString
Browse files Browse the repository at this point in the history
Signed-off-by: Liyun Xiu <xiliyun@amazon.com>
  • Loading branch information
chishui committed May 24, 2024
1 parent 8ac6806 commit 17f01d1
Showing 1 changed file with 3 additions and 0 deletions.
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 cautious.
*/
@Override
public String toString() {
Expand Down

0 comments on commit 17f01d1

Please sign in to comment.