Class DatabindCodec

java.lang.Object

io.vertx.core.json.jackson.JacksonCodec

io.vertx.core.json.jackson.DatabindCodec

All Implemented Interfaces:

JsonCodec

public class DatabindCodec
extends JacksonCodec

Author:

Julien Viet

Constructor Summary

Constructors

Constructor	Description
DatabindCodec()

Method Summary

Modifier and Type	Method	Description
static JsonParser	createParser(io.vertx.core.internal.buffer.BufferInternal buf)
static JsonParser	createParser(String str)
<T> T	fromBuffer(Buffer buf, TypeReference<T> typeRef)
<T> T	fromBuffer(Buffer buf, Class<T> clazz)	Like JsonCodec.fromString(String, Class) but with a json Buffer
static <T> T	fromParser(JsonParser parser, Class<T> type)
<T> T	fromReader(Reader reader, Class<T> clazz)	Decode JSON from the given Reader to an object of the specified type.
<T> T	fromStream(InputStream in, Class<T> clazz)	Decode JSON from the given InputStream to an object of the specified type.
<T> T	fromString(String str, TypeReference<T> typeRef)
<T> T	fromString(String str, Class<T> clazz)	Decode the provide json string to an object extending clazz.
<T> T	fromValue(Object json, TypeReference<T> type)
<T> T	fromValue(Object json, Class<T> clazz)	Like JsonCodec.fromString(String, Class) but with a json Object
static ObjectMapper	mapper()
Buffer	toBuffer(Object object, boolean pretty)	Like JsonCodec.toString(Object, boolean) but with a json Buffer
void	toStream(Object object, OutputStream out)	Encode the specified object as JSON to the given OutputStream.
String	toString(Object object, boolean pretty)	Encode the specified object to a string.
void	toWriter(Object object, Writer writer)	Encode the specified object as JSON to the given Writer.

Methods inherited from class JacksonCodec

createParser, encodeJson, fromBuffer, fromString, parseArray, parseObject, parseValue

Methods inherited from class Object

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

Methods inherited from interface JsonCodec

fromReader, fromStream, toBuffer, toString

Constructor Details

DatabindCodec

public DatabindCodec()

Method Details

mapper

public static ObjectMapper mapper()

Returns:

the ObjectMapper used for data binding.

fromValue

public <T> T fromValue(Object json,
 Class<T> clazz)

Description copied from interface: JsonCodec

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

Specified by:

fromValue in interface JsonCodec

Overrides:

fromValue in class JacksonCodec

fromValue

public <T> T fromValue(Object json,
 TypeReference<T> type)

fromString

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

Description copied from interface: JsonCodec

Decode the provide json string to an object extending clazz.

Specified by:

fromString in interface JsonCodec

Overrides:

fromString in class JacksonCodec

Parameters:

str - the json string

clazz - the required object's class

Returns:

the instance

Throws:

DecodeException - anything preventing the decoding

fromString

public <T> T fromString(String str,
 TypeReference<T> typeRef)
                 throws DecodeException

Throws:

DecodeException

fromBuffer

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

Description copied from interface: JsonCodec

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

Specified by:

fromBuffer in interface JsonCodec

Overrides:

fromBuffer in class JacksonCodec

Throws:

DecodeException

fromBuffer

public <T> T fromBuffer(Buffer buf,
 TypeReference<T> typeRef)
                 throws DecodeException

Throws:

DecodeException

fromStream

public <T> T fromStream(InputStream in,
 Class<T> clazz)
                 throws DecodeException

Description copied from interface: JsonCodec

Decode JSON from the given InputStream to an object of the specified type.

The input is expected to be UTF-8 encoded.

The codec does not close or flush the stream; the caller retains ownership.

Specified by:

fromStream in interface JsonCodec

Overrides:

fromStream in class JacksonCodec

Parameters:

in - the input stream containing UTF-8 encoded JSON

clazz - the required object's class

Returns:

the decoded instance

Throws:

DecodeException - anything preventing the decoding

createParser

public static JsonParser createParser(io.vertx.core.internal.buffer.BufferInternal buf)

createParser

public static JsonParser createParser(String str)

fromParser

public static <T> T fromParser(JsonParser parser,
 Class<T> type)
                        throws DecodeException

Throws:

DecodeException

toString

public String toString(Object object,
 boolean pretty)
                throws EncodeException

Description copied from interface: JsonCodec

Encode the specified object to a string.

Specified by:

toString in interface JsonCodec

Overrides:

toString in class JacksonCodec

Parameters:

object - the object to encode

pretty - true to format the string prettily

Returns:

the json encoded string

Throws:

EncodeException

toBuffer

public Buffer toBuffer(Object object,
 boolean pretty)
                throws EncodeException

Description copied from interface: JsonCodec

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

Specified by:

toBuffer in interface JsonCodec

Overrides:

toBuffer in class JacksonCodec

Throws:

EncodeException

toStream

public void toStream(Object object,
 OutputStream out)
              throws EncodeException

Description copied from interface: JsonCodec

Encode the specified object as JSON to the given OutputStream.

The output is UTF-8 encoded.

The codec does not close or flush the stream; the caller retains ownership.

Specified by:

toStream in interface JsonCodec

Overrides:

toStream in class JacksonCodec

Parameters:

object - the object to encode

out - the output stream to write to

Throws:

EncodeException - anything preventing the encoding

fromReader

public <T> T fromReader(Reader reader,
 Class<T> clazz)
                 throws DecodeException

Description copied from interface: JsonCodec

Decode JSON from the given Reader to an object of the specified type.

The codec does not close or flush the reader; the caller retains ownership.

Specified by:

fromReader in interface JsonCodec

Overrides:

fromReader in class JacksonCodec

Parameters:

reader - the reader containing JSON text

clazz - the required object's class

Returns:

the decoded instance

Throws:

DecodeException - anything preventing the decoding

toWriter

public void toWriter(Object object,
 Writer writer)
              throws EncodeException

Description copied from interface: JsonCodec

Encode the specified object as JSON to the given Writer.

The codec does not close or flush the writer; the caller retains ownership.

Specified by:

toWriter in interface JsonCodec

Overrides:

toWriter in class JacksonCodec

Parameters:

object - the object to encode

writer - the writer to write to

Throws:

EncodeException - anything preventing the encoding