io.vertx.core.json

Class Json

java.lang.Object

io.vertx.core.json.Json

public class Json
extends Object

Author:

Tim Fox

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectMapper	mapper Deprecated. instead use DatabindCodec.mapper()
static ObjectMapper	prettyMapper Deprecated. instead use DatabindCodec.prettyMapper()

Constructor Summary

Constructors

Constructor and Description
Json()

Method Summary

Modifier and Type	Method and Description
static Object	decodeValue(Buffer buf) Decode a given JSON buffer.
static <T> T	decodeValue(Buffer buf, Class<T> clazz) Decode a given JSON buffer to a POJO of the given class type.
static <T> T	decodeValue(Buffer buf, TypeReference<T> type) Deprecated. Instead use JacksonCodec.decodeValue(Buffer, TypeReference)
static Object	decodeValue(String str) Decode a given JSON string.
static <T> T	decodeValue(String str, Class<T> clazz) Decode a given JSON string to a POJO of the given class type.
static <T> T	decodeValue(String str, TypeReference<T> type) Deprecated. Instead use JacksonCodec.decodeValue(String, TypeReference)
static String	encode(Object obj) Encode a POJO to JSON using the underlying Jackson mapper.
static String	encodePrettily(Object obj) Encode a POJO to JSON with pretty indentation, using the underlying Jackson mapper.
static Buffer	encodeToBuffer(Object obj) Encode a POJO to JSON using the underlying Jackson mapper.

Methods inherited from class java.lang.Object

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

Field Detail

mapper

@Deprecated
public static ObjectMapper mapper

Deprecated. instead use DatabindCodec.mapper()

prettyMapper

@Deprecated
public static ObjectMapper prettyMapper

Deprecated. instead use DatabindCodec.prettyMapper()

Constructor Detail

Json

public Json()

Method Detail

encode

public static String encode(Object obj)
                     throws EncodeException

Encode a POJO to JSON using the underlying Jackson mapper.

Parameters:

obj - a POJO

Returns:

a String containing the JSON representation of the given POJO.

Throws:

EncodeException - if a property cannot be encoded.

encodeToBuffer

public static Buffer encodeToBuffer(Object obj)
                             throws EncodeException

Encode a POJO to JSON using the underlying Jackson mapper.

Parameters:

obj - a POJO

Returns:

a Buffer containing the JSON representation of the given POJO.

Throws:

EncodeException - if a property cannot be encoded.

encodePrettily

public static String encodePrettily(Object obj)
                             throws EncodeException

Encode a POJO to JSON with pretty indentation, using the underlying Jackson mapper.

Parameters:

obj - a POJO

Returns:

a String containing the JSON representation of the given POJO.

Throws:

EncodeException - if a property cannot be encoded.

decodeValue

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

Decode a given JSON string to a POJO of the given class type.

Type Parameters:

T - the generic type.

Parameters:

str - the JSON string.

clazz - the class to map to.

Returns:

an instance of T

Throws:

DecodeException - when there is a parsing or invalid mapping.

decodeValue

public static Object decodeValue(String str)
                          throws DecodeException

Decode a given JSON string.

Parameters:

str - the JSON string.

Returns:

a JSON element which can be a JsonArray, JsonObject, String, ...etc if the content is an array, object, string, ...etc

Throws:

DecodeException - when there is a parsing or invalid mapping.

decodeValue

@Deprecated
public static <T> T decodeValue(String str,
                                            TypeReference<T> type)
                                     throws DecodeException

Deprecated. Instead use JacksonCodec.decodeValue(String, TypeReference)

Decode a given JSON string to a POJO of the given type.

Type Parameters:

T - the generic type.

Parameters:

str - the JSON string.

type - the type to map to.

Returns:

an instance of T

Throws:

DecodeException - when there is a parsing or invalid mapping.

decodeValue

public static Object decodeValue(Buffer buf)
                          throws DecodeException

Decode a given JSON buffer.

Parameters:

buf - the JSON buffer.

Returns:

a JSON element which can be a JsonArray, JsonObject, String, ...etc if the buffer contains an array, object, string, ...etc

Throws:

DecodeException - when there is a parsing or invalid mapping.

decodeValue

@Deprecated
public static <T> T decodeValue(Buffer buf,
                                            TypeReference<T> type)
                                     throws DecodeException

Deprecated. Instead use JacksonCodec.decodeValue(Buffer, TypeReference)

Decode a given JSON buffer to a POJO of the given class type.

Type Parameters:

T - the generic type.

Parameters:

buf - the JSON buffer.

type - the type to map to.

Returns:

an instance of T

Throws:

DecodeException - when there is a parsing or invalid mapping.

decodeValue

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

Decode a given JSON buffer to a POJO of the given class type.

Type Parameters:

T - the generic type.

Parameters:

buf - the JSON buffer.

clazz - the class to map to.

Returns:

an instance of T

Throws:

DecodeException - when there is a parsing or invalid mapping.