blob: c9dc0946a3e86b60b76aa45dcdbc930ebe5d46c9 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.data;
/**
* Generic API for classes that contain data representable as JSON.
*/
public interface JsonProducer {
/**
* Append the JSON representation of this object's data to a StringBuilder.
* Note that when passing compact=false the generated string will
* be human-readable and containing embedded newlines; also the
* exact indentation etc may change, so use compact=true for a
* canonical format.
*
* @param target the StringBuilder to append to.
* @return the target passed in is also returned (to allow chaining).
*/
StringBuilder writeJson(StringBuilder target);
/**
* Convenience method equivalent to:
* writeJson(new StringBuilder()).toString()
*
* @return a String containing JSON representation of this object's data.
*/
default String toJson() {
return writeJson(new StringBuilder()).toString();
}
}
|
