io.cloudevents.json

Class Json

java.lang.Object

io.cloudevents.json.Json

public final class Json
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

Method Summary

Modifier and Type	Method and Description
static <T> T	binaryDecodeValue(byte[] json, Class<?> parametrized, Class<?>... parameterClasses) Example of use:
protected static <T> T	binaryDecodeValue(byte[] payload, Class<T> clazz)
static byte[]	binaryEncode(Object obj) Encode a POJO to JSON using the underlying Jackson mapper.
static <T,H> byte[]	binaryMarshal(T data, Map<String,H> headers) Marshalls the 'data' value as JSON, producing a byte array
static <T,A extends Attributes> DataUnmarshaller<byte[],T,A>	binaryUmarshaller(Class<T> type) Unmarshals a byte array into T type
static <T> T	decodeValue(String str, Class<?> parametrized, Class<?>... parameterClasses) Example of use:
protected 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, com.fasterxml.jackson.core.type.TypeReference<T> type) Decode a given JSON string to a POJO of the given type.
static String	encode(Object obj) Encode a POJO to JSON using the underlying Jackson mapper.
static <T> T	fromInputStream(InputStream inputStream, Class<T> clazz)
static <T,H> DataMarshaller<String,T,H>	marshaller() Creates a JSON Data Marshaller that produces a String
static <T,A extends Attributes> DataUnmarshaller<String,T,A>	umarshaller(Class<T> type) Creates a JSON Data Unmarshaller

Methods inherited from class java.lang.Object

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

Field Detail

MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

Method Detail

encode

public static String encode(Object obj)
                     throws IllegalStateException

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:

IllegalStateException - if a property cannot be encoded.

binaryEncode

public static byte[] binaryEncode(Object obj)
                           throws IllegalStateException

Encode a POJO to JSON using the underlying Jackson mapper.

Parameters:

obj - a POJO

Returns:

a byte array containing the JSON representation of the given POJO.

Throws:

IllegalStateException - if a property cannot be encoded.

fromInputStream

public static <T> T fromInputStream(InputStream inputStream,
                                    Class<T> clazz)

decodeValue

protected static <T> T decodeValue(String str,
                                   Class<T> clazz)
                            throws IllegalStateException

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 or null when str is an empty string or null

Throws:

IllegalStateException - when there is a parsing or invalid mapping.

binaryDecodeValue

protected static <T> T binaryDecodeValue(byte[] payload,
                                         Class<T> clazz)

decodeValue

public static <T> T decodeValue(String str,
                                com.fasterxml.jackson.core.type.TypeReference<T> type)
                         throws IllegalStateException

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 or null when str is an empty string or null

Throws:

IllegalStateException - when there is a parsing or invalid mapping.

decodeValue

public static <T> T decodeValue(String str,
                                Class<?> parametrized,
                                Class<?>... parameterClasses)

Example of use:

 String someJson = "...";
 Class clazz = Much.class;
 
 Json.decodeValue(someJson, CloudEventImpl.class, clazz);
 

Type Parameters:

T - the generic type.

Parameters:

str - The JSON String to parse

parametrized - Actual full type

parameterClasses - Type parameters to apply

Returns:

An instance of T or null when str is an empty string or null

See Also:

ObjectMapper.getTypeFactory(), TypeFactory.constructParametricType(Class, Class...)

binaryDecodeValue

public static <T> T binaryDecodeValue(byte[] json,
                                      Class<?> parametrized,
                                      Class<?>... parameterClasses)

Example of use:

 String someJson = "...";
 Class clazz = Much.class;
 
 Json.decodeValue(someJson, CloudEventImpl.class, clazz);
 

Type Parameters:

T - the generic type.

Parameters:

json - The JSON byte array to parse

parametrized - Actual full type

parameterClasses - Type parameters to apply

Returns:

An instance of T or null when str is an empty string or null

See Also:

ObjectMapper.getTypeFactory(), TypeFactory.constructParametricType(Class, Class...)

umarshaller

public static <T,A extends Attributes> DataUnmarshaller<String,T,A> umarshaller(Class<T> type)

Creates a JSON Data Unmarshaller

Type Parameters:

T - The 'data' type

A - The attributes type

Parameters:

type - The type of 'data'

Returns:

A new instance of DataUnmarshaller

binaryUmarshaller

public static <T,A extends Attributes> DataUnmarshaller<byte[],T,A> binaryUmarshaller(Class<T> type)

Unmarshals a byte array into T type

Type Parameters:

T - The 'data' type

A - The attributes type

Parameters:

payload - The byte array

attribues -

Returns:

The data objects

marshaller

public static <T,H> DataMarshaller<String,T,H> marshaller()

Creates a JSON Data Marshaller that produces a String

Type Parameters:

T - The 'data' type

H - The type of headers value

Returns:

A new instance of DataMarshaller

binaryMarshal

public static <T,H> byte[] binaryMarshal(T data,
                                         Map<String,H> headers)

Marshalls the 'data' value as JSON, producing a byte array

Type Parameters:

T - The 'data' type

H - The type of headers value

Parameters:

data - The 'data' value

headers - The headers

Returns:

A byte array with 'data' value encoded JSON