Class JacksonCodec

java.lang.Object

io.vertx.core.json.jackson.JacksonCodec

All Implemented Interfaces:

JsonCodec

Direct Known Subclasses:

DatabindCodec

public class JacksonCodec
extends Object
implements JsonCodec

Author:

Julien Viet

Constructor Summary

Constructors

Constructor	Description
JacksonCodec()

Method Summary

Modifier and Type	Method	Description
static JsonParser	createParser(Buffer buf)
static JsonParser	createParser(String str)
static void	encodeJson(Object json, JsonGenerator generator)
Object	fromBuffer(Buffer buf)
<T> T	fromBuffer(Buffer json, 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.
Object	fromString(String str)
<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 JsonCodec.fromString(String, Class) but with a json Object
static List<Object>	parseArray(JsonParser parser)	Parse a JSON array given the parser, the parser current token must be JsonTokenId.ID_START_ARRAY
static Map<String,Object>	parseObject(JsonParser parser)	Parse a JSON object given the parser, the parser current token must be JsonTokenId.ID_START_OBJECT
static Object	parseValue(JsonParser parser)	Parse a JSON value given the parser, consuming the current parser token and possibly more when parsing an object or an array.
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 Object

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

Methods inherited from interface JsonCodec

fromReader, fromStream, toBuffer, toString

Constructor Details

JacksonCodec

public JacksonCodec()

Method Details

fromString

public <T> T fromString(String json,
 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

Parameters:

json - the json string

clazz - the required object's class

Returns:

the instance

Throws:

DecodeException - anything preventing the decoding

fromBuffer

public <T> T fromBuffer(Buffer json,
 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

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

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

fromValue

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

Description copied from interface: JsonCodec

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

Specified by:

fromValue in interface JsonCodec

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

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

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

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

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

Parameters:

object - the object to encode

writer - the writer to write to

Throws:

EncodeException - anything preventing the encoding

createParser

public static JsonParser createParser(String str)

createParser

public static JsonParser createParser(Buffer buf)

fromString

public Object fromString(String str)
                  throws DecodeException

Throws:

DecodeException

fromBuffer

public Object fromBuffer(Buffer buf)
                  throws DecodeException

Throws:

DecodeException

fromParser

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

Throws:

DecodeException

parseValue

public static Object parseValue(JsonParser parser)
                         throws IOException,
DecodeException

Parse a JSON value given the parser, consuming the current parser token and possibly more when parsing an object or an array.

Parameters:

parser - the parser

Returns:

the parsed value as an object

Throws:

IOException

DecodeException

parseObject

public static Map<String,Object> parseObject(JsonParser parser)
                                      throws IOException

Parse a JSON object given the parser, the parser current token must be JsonTokenId.ID_START_OBJECT

Parameters:

parser - the parser

Returns:

the parsed object

Throws:

IOException

parseArray

public static List<Object> parseArray(JsonParser parser)
                               throws IOException

Parse a JSON array given the parser, the parser current token must be JsonTokenId.ID_START_ARRAY

Parameters:

parser - the parser

Returns:

the parsed array

Throws:

IOException

encodeJson

public static void encodeJson(Object json,
 JsonGenerator generator)
                       throws EncodeException

Throws:

EncodeException