Most visited

Recently visited

Added in API level 1

JSONStringer

public class JSONStringer
extends Object

java.lang.Object
    org.json.JSONStringer


实现toString()和toString() 。 大多数应用程序开发人员应直接使用这些方法并忽略此API。 例如:

 JSONObject object = ...
 String json = object.toString();

Stringers只编码格式正确的JSON字符串。 尤其是:

Calls that would result in a malformed JSON string will fail with a JSONException.

此类不提供漂亮打印(即缩进)输出。 要编码缩进输出,请使用toString(int)或toString(int) 。

API的某些实现最多支持20层嵌套。 试图创建超过20层的嵌套可能会失败, JSONException 。

每个纵梁可用于编码单个顶层值。 这个类的实例不是线程安全的。 虽然这个类是非终结性的,但它不是为继承而设计的,也不应该被继承。 特别是,没有指定可覆盖方法的自我使用。 有关更多信息,请参见有效Java项目17“设计和文档或继承或禁止它”。

摘要(Summary)

Public constructors

JSONStringer()

公共方法(Public methods)

JSONStringer array()

开始编码一个新的数组。

JSONStringer endArray()

结束编码当前数组。

JSONStringer endObject()

结束编码当前对象。

JSONStringer key(String name)

将密钥(属性名称)编码为此纵梁。

JSONStringer object()

开始编码一个新的对象。

String toString()

返回编码的JSON字符串。

JSONStringer value(long value)

编码 value给这个 value 。

JSONStringer value(double value)

将 value编码 value 。

JSONStringer value(boolean value)

编码 value给这个 value 。

JSONStringer value(Object value)

编码 value 。

继承方法(Inherited methods)

From class java.lang.Object

Public constructors

JSONStringer

Added in API level 1
JSONStringer ()

公共方法(Public methods)

array

Added in API level 1
JSONStringer array ()

开始编码一个新的数组。 每次调用此方法必须与对endArray()的调用进行endArray() 。

返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

endArray

Added in API level 1
JSONStringer endArray ()

结束编码当前数组。

返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

endObject

Added in API level 1
JSONStringer endObject ()

结束编码当前对象。

返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

key

Added in API level 1
JSONStringer key (String name)

将密钥(属性名称)编码为此纵梁。

参数(Parameters)
name String: the name of the forthcoming value. May not be null.
返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

object

Added in API level 1
JSONStringer object ()

开始编码一个新的对象。 每次调用此方法必须与对endObject()的调用进行endObject() 。

返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

toString

Added in API level 1
String toString ()

返回编码的JSON字符串。

如果调用未终止的数组或未关闭的对象,则此方法的返回值未定义。

警告:虽然它与 toString()的一般合同相矛盾,但如果纵梁不包含任何数据,则此方法返回null。

返回(Returns)
String a string representation of the object.

value

Added in API level 1
JSONStringer value (long value)

将 value编码为这个 value 。

参数(Parameters)
value long
返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

value

Added in API level 1
JSONStringer value (double value)

编码 value给这个 value 。

参数(Parameters)
value double: a finite value. May not be NaNs or infinities.
返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

value

Added in API level 1
JSONStringer value (boolean value)

将 value编码为这个 value 。

参数(Parameters)
value boolean
返回(Returns)
JSONStringer this stringer.
抛出异常(Throws)
JSONException

value

Added in API level 1
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

Hooray!