org.dromara.hutool.json.writer

Class JSONWriter

java.lang.Object

java.io.Writer

org.dromara.hutool.json.writer.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()
JSONConfig	getConfig() 获取JSON配置
static JSONWriter	of(Writer writer, int indentFactor, int indent, JSONConfig config) 创建JSONWriter
void	write(char[] cbuf, int off, int len)
JSONWriter	writeField(MutableEntry<Object,Object> pair, Predicate<MutableEntry<Object,Object>> predicate) 写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容 在arrayMode 为 true 时，key是数字，此时不写出键，只写值
JSONWriter	writeKey(String key) 写出键，自动处理分隔符和缩进，并包装键名
JSONWriter	writeLF() 写出换行符
void	writeQuoteStrValue(String csq) 写出字符串值，并包装引号并转义字符 对所有双引号做转义处理（使用双反斜杠做转义） 为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
JSONWriter	writeRaw(char c) 写入原始字符值，不做任何处理
JSONWriter	writeRaw(String csq) 写入原始字符串值，不做任何处理
void	writeSpace(int count) 写出空格

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

getConfig

public JSONConfig getConfig()

获取JSON配置

Returns:

JSONConfig

beginObj

public JSONWriter beginObj()

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

Returns:

this

beginArray

public JSONWriter beginArray()

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

Returns:

this

end

public JSONWriter end()

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

Returns:

this

writeField

public JSONWriter writeField(MutableEntry<Object,Object> pair,
                             Predicate<MutableEntry<Object,Object>> predicate)

写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容
在arrayMode 为 true 时，key是数字，此时不写出键，只写值

Parameters:

pair - 键值对

predicate - 过滤修改器

Returns:

this

Since:

6.0.0

writeKey

public JSONWriter writeKey(String key)

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

Parameters:

key - 键名

Returns:

this

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

writeQuoteStrValue

public void writeQuoteStrValue(String csq)

写出字符串值，并包装引号并转义字符
对所有双引号做转义处理（使用双反斜杠做转义）
为了能在HTML中较好的显示，会将</转义为<\/
JSON字符串中不能包含控制字符和未经转义的引号和反斜杠

Parameters:

csq - 字符串

writeSpace

public void writeSpace(int count)

写出空格

Parameters:

count - 空格数

writeLF

public JSONWriter writeLF()

写出换行符

Returns:

this

writeRaw

public JSONWriter writeRaw(String csq)

写入原始字符串值，不做任何处理

Parameters:

csq - 字符串

Returns:

this

writeRaw

public JSONWriter writeRaw(char c)

写入原始字符值，不做任何处理

Parameters:

c - 字符

Returns:

this