Package org.springframework.boot.json

Interface WritableJson

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface WritableJson

JSON content that can be written out.

Since:

3.4.0

Author:

Phillip Webb, Moritz Halbritter

See Also:

• JsonWriter

Method Summary

Modifier and Type	Method	Description
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.

Method Details

to

void to(Appendable out)
 throws IOException

Write the JSON to the provided Appendable.

Parameters:

out - the Appendable to receive the JSON

Throws:

IOException - on IO error

toJsonString

default String toJsonString()

Write the JSON to a String.

Returns:

the JSON string

toByteArray

default byte[] toByteArray()

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

Returns:

the JSON bytes

toByteArray

default byte[] toByteArray(Charset charset)

Write the JSON to a byte array.

Parameters:

charset - the charset

Returns:

the JSON bytes

toResource

default void toResource(WritableResource out)
                 throws IOException

Write the JSON to the provided WritableResource using UTF8 encoding.

Parameters:

out - the OutputStream to receive the JSON

Throws:

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.

Parameters:

out - the OutputStream to receive the JSON

charset - the charset to use

Throws:

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.

Parameters:

out - the OutputStream to receive the JSON

Throws:

IOException - on IO error

See Also:

• 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.

Parameters:

out - the OutputStream to receive the JSON

charset - the charset to use

Throws:

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.

Parameters:

out - the Writer to receive the JSON

Throws:

IOException - on IO error

See Also:

• 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().

Parameters:

writableJson - the source WritableJson

Returns:

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