cn.hutool.json.serialize

类 JSONWriter

java.lang.Object

java.io.Writer

cn.hutool.json.serialize.JSONWriter

所有已实现的接口:

Closeable, Flushable, Appendable, AutoCloseable

public class JSONWriter
extends Writer

JSON数据写出器
通过简单的append方式将JSON的键值对等信息写出到Writer中。

从以下版本开始:

5.7.3

作者:

looly

字段概要

从类继承的字段 java.io.Writer

lock

构造器概要

构造器

构造器和说明
JSONWriter(Writer writer, int indentFactor, int indent, JSONConfig config) 构造

方法概要

限定符和类型	方法和说明
JSONWriter	beginArray() JSONArray写出开始，默认写出"["
JSONWriter	beginObj() JSONObject写出开始，默认写出"{"
void	close()
JSONWriter	end() 结束，默认根据开始的类型，补充"}"或"]"
void	flush()
static JSONWriter	of(Writer writer, int indentFactor, int indent, JSONConfig config) 创建JSONWriter
void	write(char[] cbuf, int off, int len)
JSONWriter	writeField(MutablePair<Object,Object> pair, Filter<MutablePair<Object,Object>> filter) 写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容
JSONWriter	writeField(String key, Object value) 已过时。 请使用 writeField(MutablePair, Filter)
JSONWriter	writeKey(String key) 写出键，自动处理分隔符和缩进，并包装键名
JSONWriter	writeValue(Object value) 写出值，自动处理分隔符和缩进，自动判断类型，并根据不同类型写出特定格式的值 如果写出的值为null或者JSONNull，且配置忽略null，则跳过。

从类继承的方法 java.io.Writer

append, append, append, write, write, write, write

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

JSONWriter

public JSONWriter(Writer writer,
                  int indentFactor,
                  int indent,
                  JSONConfig config)

构造

参数:

writer - Writer

indentFactor - 缩进因子，定义每一级别增加的缩进量

indent - 本级别缩进量

config - JSON选项

方法详细资料

of

public static JSONWriter of(Writer writer,
                            int indentFactor,
                            int indent,
                            JSONConfig config)

创建JSONWriter

参数:

writer - Writer

indentFactor - 缩进因子，定义每一级别增加的缩进量

indent - 本级别缩进量

config - JSON选项

返回:

JSONWriter

beginObj

public JSONWriter beginObj()

JSONObject写出开始，默认写出"{"

返回:

this

beginArray

public JSONWriter beginArray()

JSONArray写出开始，默认写出"["

返回:

this

end

public JSONWriter end()

结束，默认根据开始的类型，补充"}"或"]"

返回:

this

writeKey

public JSONWriter writeKey(String key)

写出键，自动处理分隔符和缩进，并包装键名

参数:

key - 键名

返回:

this

writeValue

public JSONWriter writeValue(Object value)

写出值，自动处理分隔符和缩进，自动判断类型，并根据不同类型写出特定格式的值
如果写出的值为null或者JSONNull，且配置忽略null，则跳过。

参数:

value - 值

返回:

this

writeField

@Deprecated
public JSONWriter writeField(String key,
                                          Object value)

已过时。 请使用 writeField(MutablePair, Filter)

写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容

参数:

key - 字段名

value - 字段值

返回:

this

从以下版本开始:

5.7.6

writeField

public JSONWriter writeField(MutablePair<Object,Object> pair,
                             Filter<MutablePair<Object,Object>> filter)

写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容

参数:

pair - 键值对

filter - 键值对的过滤器，可以编辑键值对

返回:

this

从以下版本开始:

5.8.6

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException

指定者:

write 在类中 Writer

抛出:

IOException

flush

public void flush()

指定者:

flush 在接口中 Flushable

指定者:

flush 在类中 Writer

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在类中 Writer

抛出:

IOException