io.vertx.core.spi.json

Interface JsonCodec

All Known Implementing Classes:

JacksonCodec

public interface JsonCodec

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static JsonCodec	INSTANCE Static cached codec instance, initialized with loadCodec().

Method Summary

Modifier and Type	Method and Description
<T> T	fromBuffer(Buffer json, Class<T> clazz) Like fromString(String, Class) but with a json Buffer
<T> T	fromString(String json, Class<T> clazz) Decode the provide json string to an object extending clazz.
<T> T	fromValue(Object json, Class<T> toValueType) Like fromString(String, Class) but with a json Object
static JsonCodec	loadCodec() Load the JSON codec with the ServiceLoader An attempt is made to load a factory using the service loader META-INF/services JsonCodec. Codecs are sorted If no codec is resolved (which is usually the default case), the a JacksonCodec is created and used.
default int	order() The order of the codec.
default Buffer	toBuffer(Object object) Like toString(Object) but with a json Buffer
Buffer	toBuffer(Object object, boolean pretty) Like toString(Object, boolean) but with a json Buffer
default String	toString(Object object) Encode the specified object to a string.
String	toString(Object object, boolean pretty) Encode the specified object to a string.

Field Detail

INSTANCE

static final JsonCodec INSTANCE

Static cached codec instance, initialized with loadCodec().

Method Detail

loadCodec

static JsonCodec loadCodec()

Load the JSON codec with the ServiceLoader

• An attempt is made to load a factory using the service loader META-INF/services JsonCodec.
• Codecs are sorted
• If no codec is resolved (which is usually the default case), the a JacksonCodec is created and used.

order

default int order()

The order of the codec. If there is more than one matching codec they will be tried in ascending order.

Returns:

the order

fromString

<T> T fromString(String json,
                 Class<T> clazz)
          throws DecodeException

Decode the provide json string to an object extending clazz.

Parameters:

json - the json string

clazz - the required object's class

Returns:

the instance

Throws:

DecodeException - anything preventing the decoding

fromBuffer

<T> T fromBuffer(Buffer json,
                 Class<T> clazz)
          throws DecodeException

Like fromString(String, Class) but with a json Buffer

Throws:

DecodeException

fromValue

<T> T fromValue(Object json,
                Class<T> toValueType)

Like fromString(String, Class) but with a json Object

toString

default String toString(Object object)
                 throws EncodeException

Encode the specified object to a string.

Throws:

EncodeException

toString

String toString(Object object,
                boolean pretty)
         throws EncodeException

Encode the specified object to a string.

Parameters:

object - the object to encode

pretty - true to format the string prettily

Returns:

the json encoded string

Throws:

DecodeException - anything preventing the encoding

EncodeException

toBuffer

Buffer toBuffer(Object object,
                boolean pretty)
         throws EncodeException

Like toString(Object, boolean) but with a json Buffer

Throws:

EncodeException

toBuffer

default Buffer toBuffer(Object object)
                 throws EncodeException

Like toString(Object) but with a json Buffer

Throws:

EncodeException