cn.hutool.json.serialize

Class JSONWriter

java.lang.Object

java.io.Writer

cn.hutool.json.serialize.JSONWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class JSONWriter
extends Writer

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

Since:

5.7.3

Author:

looly

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
JSONWriter(Writer writer, int indentFactor, int indent, JSONConfig config) 构造

Method Summary

Modifier and Type	Method and Description
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) Deprecated. 请使用 writeField(MutablePair, Filter)
JSONWriter	writeKey(String key) 写出键，自动处理分隔符和缩进，并包装键名
JSONWriter	writeValue(Object value) 写出值，自动处理分隔符和缩进，自动判断类型，并根据不同类型写出特定格式的值 如果写出的值为null或者JSONNull，且配置忽略null，则跳过。

Methods inherited from class java.io.Writer

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONWriter

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

构造

Parameters:

writer - Writer

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

indent - 本级别缩进量

config - JSON选项

Method Detail

of

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

创建JSONWriter

Parameters:

writer - Writer

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

indent - 本级别缩进量

config - JSON选项

Returns:

JSONWriter

beginObj

public JSONWriter beginObj()

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

Returns:

this

beginArray

public JSONWriter beginArray()

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

Returns:

this

end

public JSONWriter end()

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

Returns:

this

writeKey

public JSONWriter writeKey(String key)

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

Parameters:

key - 键名

Returns:

this

writeValue

public JSONWriter writeValue(Object value)

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

Parameters:

value - 值

Returns:

this

writeField

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

Deprecated. 请使用 writeField(MutablePair, Filter)

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

Parameters:

key - 字段名

value - 字段值

Returns:

this

Since:

5.7.6

writeField

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

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

Parameters:

pair - 键值对

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

Returns:

this

Since:

5.8.6

write

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

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Writer

Throws:

IOException