Package tech.ydb.yoj.repository.db.json

Class JacksonJsonConverter

java.lang.Object

tech.ydb.yoj.repository.db.json.JacksonJsonConverter

All Implemented Interfaces:

JsonConverter

public final class JacksonJsonConverter
extends Object
implements JsonConverter

YOJ JSON Converter implementation using Jackson as the underlying JSON library. Use it to support JSON-valued fields (@Column(flatten=false) composite objects and dynamic fields with type of interface/abstract class, e.g. List):

 CommonConverters.defineJsonConverter(JacksonJsonConverter.getDefault());
 

Note that the CommonConverters.defineJsonConverter() configuration API is unstable and subject to change (and potential deprecation for removal.)

You can obtain an instance of JacksonJsonConverter in a number of ways:

• To get JacksonJsonConverter which uses reasonable defaults, call getDefault().
• To customize these reasonable defaults, use the JacksonJsonConverter(UnaryOperator) constructor:

   CommonConverters.defineJsonConverter(new JacksonJsonConverter(mapper -> mapper
       .set[...]()
       .registerModule(...)
       .configure(...)
   ));
   

• To supply an externally created ObjectMapper, use the #JacksonJsonConverter(ObjectMapper) constructor.

Field Summary

Fields inherited from interface tech.ydb.yoj.repository.db.common.JsonConverter

NONE

Constructor Summary

Constructors

Constructor	Description
JacksonJsonConverter(UnaryOperator<com.fasterxml.jackson.databind.ObjectMapper> mapperBuilder)

Method Summary

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.ObjectMapper	createDefaultObjectMapper()
<T> T	fromJson(@NonNull Type type, @NonNull String content)
<T> T	fromObject(@NonNull Type type, Object content)
static JsonConverter	getDefault()
String	toJson(@NonNull Type type, Object o)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JacksonJsonConverter

public JacksonJsonConverter(UnaryOperator<com.fasterxml.jackson.databind.ObjectMapper> mapperBuilder)

Method Details

getDefault

public static JsonConverter getDefault()

Returns:

JsonConverter with reasonable defaults, using Jackson for JSON serialization and deserialization

toJson

public String toJson(@NonNull
 @NonNull Type type,
 @Nullable
 Object o)
              throws ConversionException

Specified by:

toJson in interface JsonConverter

Throws:

ConversionException

fromJson

public <T> T fromJson(@NonNull
 @NonNull Type type,
 @NonNull
 @NonNull String content)
               throws ConversionException

Specified by:

fromJson in interface JsonConverter

Throws:

ConversionException

fromObject

public <T> T fromObject(@NonNull
 @NonNull Type type,
 @Nullable
 Object content)
                 throws ConversionException

Specified by:

fromObject in interface JsonConverter

Throws:

ConversionException

toString

public String toString()

Overrides:

toString in class Object

createDefaultObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper createDefaultObjectMapper()

Returns:

ObjectMapper with reasonable defaults for mapping between Java objects and JSON