Package io.valkey.springframework.data.valkey.serializer

Class GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder

java.lang.Object

io.valkey.springframework.data.valkey.serializer.GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder

Enclosing class:

GenericJackson2JsonValkeySerializer

public static class GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder
extends Object

Builder for configuring and creating a GenericJackson2JsonValkeySerializer.

Since:

3.3.1

Author:

Anne Lee, Mark Paluch

Method Summary

Modifier and Type	Method	Description
GenericJackson2JsonValkeySerializer	build()	Creates a new instance of GenericJackson2JsonValkeySerializer with configuration options applied.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	defaultTyping(boolean defaultTyping)	Enable or disable default typing.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	nullValueSerializer(com.fasterxml.jackson.databind.ser.std.StdSerializer<org.springframework.cache.support.NullValue> nullValueSerializer)	Register a serializer for NullValue.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Configure a provided ObjectMapper.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	reader(JacksonObjectReader reader)	Configure JacksonObjectReader.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	registerNullValueSerializer(boolean registerNullValueSerializer)	Configure whether to register a serializer for NullValue serialization.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	typeHintPropertyName(String typeHintPropertyName)	Configure a property name to that represents the type hint.
GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder	writer(JacksonObjectWriter writer)	Configure JacksonObjectWriter.

Methods inherited from class java.lang.Object

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

Method Details

defaultTyping

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder defaultTyping(boolean defaultTyping)

Enable or disable default typing. Enabling default typing will override ObjectMapper.setDefaultTyping(com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder) for a given ObjectMapper. Default typing is enabled by default if no ObjectMapper is provided.

Parameters:

defaultTyping - whether to enable/disable default typing. Enabled by default if the ObjectMapper is not provided.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

typeHintPropertyName

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder typeHintPropertyName(String typeHintPropertyName)

Configure a property name to that represents the type hint.

Parameters:

typeHintPropertyName - name of the JSON property holding type information.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

objectMapper

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder objectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Configure a provided ObjectMapper. Note that the provided ObjectMapper can be reconfigured with a nullValueSerializer or default typing depending on the builder configuration.

Parameters:

objectMapper - must not be null.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

reader

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder reader(JacksonObjectReader reader)

Configure JacksonObjectReader.

Parameters:

reader - must not be null.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

writer

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder writer(JacksonObjectWriter writer)

Configure JacksonObjectWriter.

Parameters:

writer - must not be null.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

nullValueSerializer

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder nullValueSerializer(com.fasterxml.jackson.databind.ser.std.StdSerializer<org.springframework.cache.support.NullValue> nullValueSerializer)

Register a serializer for NullValue.

Parameters:

nullValueSerializer - the StdSerializer to use for NullValue serialization, must not be null.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

registerNullValueSerializer

public GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder registerNullValueSerializer(boolean registerNullValueSerializer)

Configure whether to register a serializer for NullValue serialization. The default serializer considers typeHintPropertyName(String).

Parameters:

registerNullValueSerializer - true to register the default serializer; false otherwise.

Returns:

this GenericJackson2JsonValkeySerializer.GenericJackson2JsonValkeySerializerBuilder.

build

public GenericJackson2JsonValkeySerializer build()

Creates a new instance of GenericJackson2JsonValkeySerializer with configuration options applied. Creates also a new ObjectMapper if none was provided.

Returns:

a new instance of GenericJackson2JsonValkeySerializer.