org.dromara.hutool.json.writer

Class JSONWriter

java.lang.Object

org.dromara.hutool.json.writer.JSONWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class JSONWriter
extends Object
implements Appendable, Flushable, Closeable

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

Since:

5.7.3

Author:

looly

Constructor Summary

Constructors

Constructor and Description
JSONWriter(Appendable appendable, JSONFormatStyle formatStyle, int level, JSONConfig config, Predicate<MutableEntry<Object,Object>> predicate) 构造

Method Summary

Modifier and Type	Method and Description
JSONWriter	append(char c)
JSONWriter	append(CharSequence csq)
JSONWriter	append(CharSequence csq, int start, int end)
JSONWriter	beginArray() JSONArray写出开始，默认写出"["
JSONWriter	beginObj() JSONObject写出开始，默认写出"{"
void	close()
JSONWriter	endArray() 结束JSON数组，默认根据开始的类型，补充"]"
JSONWriter	endObj() 结束JSON对象，默认根据开始的类型，补充"}"
void	flush()
JSONConfig	getConfig() 获取JSON配置
static JSONWriter	of(Appendable appendable, int indentFactor, int level, JSONConfig config, Predicate<MutableEntry<Object,Object>> predicate) 创建JSONWriter
static JSONWriter	of(Appendable appendable, int indentFactor, JSONConfig config, Predicate<MutableEntry<Object,Object>> predicate) 创建JSONWriter
String	toString()
JSONWriter	writeField(MutableEntry<Object,Object> pair) 写出字段名及字段值，如果字段值是null且忽略null值，则不写出任何内容
void	writeIndent(int count) 写出缩进
JSONWriter	writeKey(String key) 写出键，自动处理分隔符和缩进，并包装键名
JSONWriter	writeNewLine() 写出换行符
JSONWriter	writeNumber(Number number) 写出数字，根据JSONConfig.isStripTrailingZeros() 配置不同，写出不同数字 主要针对Double型是否去掉小数点后多余的0 此方法输出的值不包装引号。
void	writeQuoteStrValue(String csq) 写出字符串值，并包装引号并转义字符 对所有双引号做转义处理（使用双反斜杠做转义） 为了能在HTML中较好的显示，会将</转义为<\/ JSON字符串中不能包含控制字符和未经转义的引号和反斜杠
JSONWriter	writeRaw(String csq) 写入原始字符串值，不做任何处理
JSONWriter	writeSpaceAfterSeparators() 写出空白字符，默认写出一个空格

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONWriter

public JSONWriter(Appendable appendable,
                  JSONFormatStyle formatStyle,
                  int level,
                  JSONConfig config,
                  Predicate<MutableEntry<Object,Object>> predicate)

构造

Parameters:

appendable - Appendable

formatStyle - 格式化风格

level - 层级

config - JSON选项

predicate - 字段过滤器

Method Detail

of

public static JSONWriter of(Appendable appendable,
                            int indentFactor,
                            JSONConfig config,
                            Predicate<MutableEntry<Object,Object>> predicate)

创建JSONWriter

Parameters:

appendable - Appendable

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

config - JSON选项

predicate - predicate 字段过滤器

Returns:

JSONWriter

of

public static JSONWriter of(Appendable appendable,
                            int indentFactor,
                            int level,
                            JSONConfig config,
                            Predicate<MutableEntry<Object,Object>> predicate)

创建JSONWriter

Parameters:

appendable - Appendable

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

level - 层级

config - JSON选项

predicate - predicate 字段过滤器

Returns:

JSONWriter

getConfig

public JSONConfig getConfig()

获取JSON配置

Returns:

JSONConfig

beginObj

public JSONWriter beginObj()

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

Returns:

this

endObj

public JSONWriter endObj()

结束JSON对象，默认根据开始的类型，补充"}"

Returns:

this

beginArray

public JSONWriter beginArray()

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

Returns:

this

endArray

public JSONWriter endArray()

结束JSON数组，默认根据开始的类型，补充"]"

Returns:

this

writeField

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

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

Parameters:

pair - 键值对

Returns:

this

Since:

6.0.0

writeKey

public JSONWriter writeKey(String key)

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

Parameters:

key - 键名

Returns:

this

flush

public void flush()

Specified by:

flush in interface Flushable

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

writeQuoteStrValue

public void writeQuoteStrValue(String csq)

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

Parameters:

csq - 字符串

writeSpaceAfterSeparators

public JSONWriter writeSpaceAfterSeparators()

写出空白字符，默认写出一个空格

Returns:

this

writeIndent

public void writeIndent(int count)

写出缩进

Parameters:

count - 空格数

writeNewLine

public JSONWriter writeNewLine()

写出换行符

Returns:

this

writeRaw

public JSONWriter writeRaw(String csq)

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

Parameters:

csq - 字符串

Returns:

this

writeNumber

public JSONWriter writeNumber(Number number)

写出数字，根据JSONConfig.isStripTrailingZeros() 配置不同，写出不同数字
主要针对Double型是否去掉小数点后多余的0
此方法输出的值不包装引号。

Parameters:

number - 数字

Returns:

this

append

public JSONWriter append(char c)
                  throws IORuntimeException

Specified by:

append in interface Appendable

Throws:

IORuntimeException

append

public JSONWriter append(CharSequence csq)
                  throws IORuntimeException

Specified by:

append in interface Appendable

Throws:

IORuntimeException

append

public JSONWriter append(CharSequence csq,
                         int start,
                         int end)
                  throws IORuntimeException

Specified by:

append in interface Appendable

Throws:

IORuntimeException

toString

public String toString()

Overrides:

toString in class Object