Interface RedisJsonSerializer

All Superinterfaces:

RedisSerializer<Object>

All Known Subinterfaces:

RedisJsonSerializer.Splitter

All Known Implementing Classes:

GenericJackson2JsonRedisSerializer, GenericJacksonJsonRedisSerializer

public interface RedisJsonSerializer
extends RedisSerializer<Object>

RedisSerializer extension for converting between Java objects and JSON bytes.

Provides deserialization into specific target types, including generic types described by ParameterizedTypeReference or ResolvableType. Also supports extracting array elements and object members as JSON and combining members into a JSON object.

Since:

4.2

Author:

Yordan Tsintsov, Mark Paluch, Moritz Halbritter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RedisJsonSerializer.Splitter	Splitter for JSON arrays and objects.

Method Summary

Modifier and Type	Method	Description
default <T> @Nullable T	deserialize(byte[] source, ParameterizedTypeReference<T> typeRef)	Deserialize the given source into an instance of the type described by a ParameterizedTypeReference.
@Nullable Object	deserialize(byte[] source, ResolvableType type)	Deserialize the given source into an instance of the type described by ResolvableType.
default RedisJsonSerializer.Splitter	splitter()	Return a RedisJsonSerializer.Splitter for this serializer.

Methods inherited from interface RedisSerializer

canSerialize, deserialize, deserialize, getTargetType, serialize

Method Details

deserialize

default <T> @Nullable T deserialize(byte[] source,
 ParameterizedTypeReference<T> typeRef)
                             throws SerializationException

Deserialize the given source into an instance of the type described by a ParameterizedTypeReference.

Use this variant for generic types such as List<Person> that cannot be expressed as a Class.

Type Parameters:

T - the target type.

Parameters:

source - the JSON bytes to read.

typeRef - the reference describing the target type.

Returns:

the deserialized object, or null if source is empty or represents JSON null.

Throws:

SerializationException - if the JSON cannot be deserialized.

deserialize

@Nullable Object deserialize(byte[] source,
 ResolvableType type)
                      throws SerializationException

Deserialize the given source into an instance of the type described by ResolvableType.

Use this variant for generic types such as List<Person> that cannot be expressed as a Class.

Parameters:

source - the JSON bytes to read.

type - the target type.

Returns:

the deserialized object, or null if source is empty or represents JSON null.

Throws:

SerializationException - if the JSON cannot be deserialized.

splitter

default RedisJsonSerializer.Splitter splitter()

Return a RedisJsonSerializer.Splitter for this serializer.