程序包 org.springframework.boot.json

接口 WritableJson

函数接口:

这是一个函数接口, 因此可用作 lambda 表达式或方法引用的赋值目标。

@FunctionalInterface
public interface WritableJson

JSON content that can be written out.

从以下版本开始:

3.4.0

作者:

Phillip Webb, Moritz Halbritter

另请参阅:

• JsonWriter

方法概要

修饰符和类型	方法	说明
static WritableJson	of(WritableJson writableJson)	Factory method used to create a WritableJson with a sensible Object.toString() that delegate to toJsonString().
void	to(Appendable out)	Write the JSON to the provided Appendable.
default byte[]	toByteArray()	Write the JSON to a UTF-8 encoded byte array.
default byte[]	toByteArray(Charset charset)	Write the JSON to a byte array.
default String	toJsonString()	Write the JSON to a String.
default void	toOutputStream(OutputStream out)	Write the JSON to the provided OutputStream using UTF8 encoding.
default void	toOutputStream(OutputStream out, Charset charset)	Write the JSON to the provided OutputStream using the given Charset.
default void	toResource(WritableResource out)	Write the JSON to the provided WritableResource using UTF8 encoding.
default void	toResource(WritableResource out, Charset charset)	Write the JSON to the provided WritableResource using the given Charset.
default void	toWriter(Writer out)	Write the JSON to the provided Writer.

方法详细资料

to

void to(Appendable out)
 throws IOException

Write the JSON to the provided Appendable.

参数:

out - the Appendable to receive the JSON

抛出:

IOException - on IO error

toJsonString

default String toJsonString()

Write the JSON to a String.

返回:

the JSON string

toByteArray

default byte[] toByteArray()

Write the JSON to a UTF-8 encoded byte array.

返回:

the JSON bytes

toByteArray

default byte[] toByteArray(Charset charset)

Write the JSON to a byte array.

参数:

charset - the charset

返回:

the JSON bytes

toResource

default void toResource(WritableResource out)
                 throws IOException

Write the JSON to the provided WritableResource using UTF8 encoding.

参数:

out - the OutputStream to receive the JSON

抛出:

IOException - on IO error

toResource

default void toResource(WritableResource out,
 Charset charset)
                 throws IOException

Write the JSON to the provided WritableResource using the given Charset.

参数:

out - the OutputStream to receive the JSON

charset - the charset to use

抛出:

IOException - on IO error

toOutputStream

default void toOutputStream(OutputStream out)
                     throws IOException

Write the JSON to the provided OutputStream using UTF8 encoding. The output stream will not be closed.

参数:

out - the OutputStream to receive the JSON

抛出:

IOException - on IO error

另请参阅:

• toOutputStream(OutputStream, Charset)

toOutputStream

default void toOutputStream(OutputStream out,
 Charset charset)
                     throws IOException

Write the JSON to the provided OutputStream using the given Charset. The output stream will not be closed.

参数:

out - the OutputStream to receive the JSON

charset - the charset to use

抛出:

IOException - on IO error

toWriter

default void toWriter(Writer out)
               throws IOException

Write the JSON to the provided Writer. The writer will be flushed but not closed.

参数:

out - the Writer to receive the JSON

抛出:

IOException - on IO error

另请参阅:

• toOutputStream(OutputStream, Charset)

of

static WritableJson of(WritableJson writableJson)

Factory method used to create a WritableJson with a sensible Object.toString() that delegate to toJsonString().

参数:

writableJson - the source WritableJson

返回:

a new WritableJson with a sensible Object.toString().