public class JSONStringer
extends Object
java.lang.Object | |
↳ | org.json.JSONStringer |
实现toString()
和toString()
。 大多数应用程序开发人员应直接使用这些方法并忽略此API。 例如:
JSONObject object = ... String json = object.toString();
Stringers只编码格式正确的JSON字符串。 尤其是:
array()
must have a matching call to endArray()
and every call to object()
must have a matching call to endObject()
. value
calls, or by nesting arrays or objects. JSONException
.
此类不提供漂亮打印(即缩进)输出。 要编码缩进输出,请使用toString(int)
或toString(int)
。
API的某些实现最多支持20层嵌套。 试图创建超过20层的嵌套可能会失败, JSONException
。
每个纵梁可用于编码单个顶层值。 这个类的实例不是线程安全的。 虽然这个类是非终结性的,但它不是为继承而设计的,也不应该被继承。 特别是,没有指定可覆盖方法的自我使用。 有关更多信息,请参见有效Java项目17“设计和文档或继承或禁止它”。
Public constructors |
|
---|---|
JSONStringer() |
Public methods |
|
---|---|
JSONStringer |
array() 开始编码一个新的数组。 |
JSONStringer |
endArray() 结束编码当前数组。 |
JSONStringer |
endObject() 结束编码当前对象。 |
JSONStringer |
key(String name) 将密钥(属性名称)编码为此纵梁。 |
JSONStringer |
object() 开始编码一个新的对象。 |
String |
toString() 返回编码的JSON字符串。 |
JSONStringer |
value(long value) 编码 |
JSONStringer |
value(double value) 将 |
JSONStringer |
value(boolean value) 编码 |
JSONStringer |
value(Object value) 编码 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
JSONStringer array ()
开始编码一个新的数组。 每次调用此方法必须与对endArray()
的调用进行endArray()
。
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer endArray ()
结束编码当前数组。
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer endObject ()
结束编码当前对象。
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer key (String name)
将密钥(属性名称)编码为此纵梁。
Parameters | |
---|---|
name |
String : the name of the forthcoming value. May not be null. |
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer object ()
开始编码一个新的对象。 每次调用此方法必须与对endObject()
的调用进行endObject()
。
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
String toString ()
返回编码的JSON字符串。
如果调用未终止的数组或未关闭的对象,则此方法的返回值未定义。
警告:虽然它与 toString()
的一般合同相矛盾,但如果纵梁不包含任何数据,则此方法返回null。
Returns | |
---|---|
String |
a string representation of the object. |
JSONStringer value (long value)
将 value
编码为这个 value
。
Parameters | |
---|---|
value |
long
|
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer value (double value)
编码 value
给这个 value
。
Parameters | |
---|---|
value |
double : a finite value. May not be NaNs or infinities . |
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer value (boolean value)
将 value
编码为这个 value
。
Parameters | |
---|---|
value |
boolean
|
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |
JSONStringer value (Object value)
编码 value
。
Parameters | |
---|---|
value |
Object : a JSONObject , JSONArray , String, Boolean, Integer, Long, Double or null. May not be NaNs or infinities . |
Returns | |
---|---|
JSONStringer |
this stringer. |
Throws | |
---|---|
JSONException |