Package org.springframework.data.redis.serializer

Interface RedisSerializationContext<K,V>

public interface RedisSerializationContext<K,V>

Serialization context for reactive use.

This context provides RedisSerializationContext.SerializationPairs for key, value, hash-key (field), hash-value and String serialization and deserialization.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl, John Blum

See Also:

• RedisElementWriter
• RedisElementReader

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RedisSerializationContext.RedisSerializationContextBuilder<K,V>	Builder for RedisSerializationContext.
static interface	RedisSerializationContext.SerializationPair<T>	Typed serialization tuple.

Method Summary

Modifier and Type	Method	Description
static RedisSerializationContext<byte[],byte[]>	byteArray()	Creates a new RedisSerializationContext using a byte[] serialization.
static RedisSerializationContext<ByteBuffer,ByteBuffer>	byteBuffer()	Creates a new RedisSerializationContext using a ByteBuffer serialization.
static <T> RedisSerializationContext<T,T>	fromSerializer(RedisSerializer<T> serializer)	Creates a new RedisSerializationContext using the given RedisSerializer.
<HK> RedisSerializationContext.SerializationPair<HK>	getHashKeySerializationPair()
<HV> RedisSerializationContext.SerializationPair<HV>	getHashValueSerializationPair()
RedisSerializationContext.SerializationPair<K>	getKeySerializationPair()
RedisSerializationContext.SerializationPair<String>	getStringSerializationPair()
RedisSerializationContext.SerializationPair<V>	getValueSerializationPair()
static RedisSerializationContext<Object,Object>	java()	Creates a new RedisSerializationContext using a JdkSerializationRedisSerializer.
static RedisSerializationContext<Object,Object>	java(ClassLoader classLoader)	Creates a new RedisSerializationContext using a JdkSerializationRedisSerializer with given ClassLoader to resolves type of the keys and values stored in Redis.
static <T> RedisSerializationContext<T,T>	just(RedisSerializationContext.SerializationPair<T> serializationPair)	Creates a new RedisSerializationContext using the given RedisSerializationContext.SerializationPair.
static <K, V> RedisSerializationContext.RedisSerializationContextBuilder<K,V>	newSerializationContext()	Creates a new RedisSerializationContext.RedisSerializationContextBuilder.
static <K, V> RedisSerializationContext.RedisSerializationContextBuilder<K,V>	newSerializationContext(RedisSerializationContext.SerializationPair<?> serializationPair)	Creates a new RedisSerializationContext.RedisSerializationContextBuilder using a given default RedisSerializationContext.SerializationPair.
static <K, V> RedisSerializationContext.RedisSerializationContextBuilder<K,V>	newSerializationContext(RedisSerializer<?> defaultSerializer)	Creates a new RedisSerializationContext.RedisSerializationContextBuilder using a given default RedisSerializer.
static RedisSerializationContext<byte[],byte[]>	raw()	Deprecated. since 2.2.
static RedisSerializationContext<String,String>	string()	Creates a new RedisSerializationContext using a StringRedisSerializer.

Method Details

newSerializationContext

static <K,
V>
RedisSerializationContext.RedisSerializationContextBuilder<K,V> newSerializationContext()

Creates a new RedisSerializationContext.RedisSerializationContextBuilder.

Type Parameters:

K - expected key type.

V - expected value type.

Returns:

a new RedisSerializationContext.RedisSerializationContextBuilder.

newSerializationContext

static <K,
V>
RedisSerializationContext.RedisSerializationContextBuilder<K,V> newSerializationContext(RedisSerializer<?> defaultSerializer)

Creates a new RedisSerializationContext.RedisSerializationContextBuilder using a given default RedisSerializer.

Type Parameters:

K - expected key type.

V - expected value type.

Parameters:

defaultSerializer - must not be null.

Returns:

a new RedisSerializationContext.RedisSerializationContextBuilder.

newSerializationContext

static <K,
V>
RedisSerializationContext.RedisSerializationContextBuilder<K,V> newSerializationContext(RedisSerializationContext.SerializationPair<?> serializationPair)

Creates a new RedisSerializationContext.RedisSerializationContextBuilder using a given default RedisSerializationContext.SerializationPair.

Type Parameters:

K - expected key type.

V - expected value type.

Parameters:

serializationPair - must not be null.

Returns:

a new RedisSerializationContext.RedisSerializationContextBuilder.

raw

@Deprecated
static RedisSerializationContext<byte[],byte[]> raw()

Deprecated.

since 2.2. Please use byteArray() instead.

Creates a new RedisSerializationContext using a byte[] serialization pair.

Returns:

new instance of RedisSerializationContext.

byteArray

static RedisSerializationContext<byte[],byte[]> byteArray()

Creates a new RedisSerializationContext using a byte[] serialization.

Returns:

new instance of RedisSerializationContext.

Since:

2.2

byteBuffer

static RedisSerializationContext<ByteBuffer,ByteBuffer> byteBuffer()

Creates a new RedisSerializationContext using a ByteBuffer serialization.

Returns:

new instance of RedisSerializationContext.

Since:

2.2

java

static RedisSerializationContext<Object,Object> java()

Creates a new RedisSerializationContext using a JdkSerializationRedisSerializer.

Returns:

a new RedisSerializationContext using JDK Serializaton.

Since:

2.1

java

static RedisSerializationContext<Object,Object> java(ClassLoader classLoader)

Creates a new RedisSerializationContext using a JdkSerializationRedisSerializer with given ClassLoader to resolves type of the keys and values stored in Redis.

Parameters:

classLoader - ClassLoader used to resolve types of keys and value stored in Redis during deserialization; can be null.

Returns:

a new RedisSerializationContext using JDK Serializaton.

Since:

2.1

string

static RedisSerializationContext<String,String> string()

Creates a new RedisSerializationContext using a StringRedisSerializer.

Returns:

a new RedisSerializationContext using a StringRedisSerializer.

fromSerializer

static <T> RedisSerializationContext<T,T> fromSerializer(RedisSerializer<T> serializer)

Creates a new RedisSerializationContext using the given RedisSerializer.

Type Parameters:

T - Type of Object being de/serialized by the RedisSerializer.

Parameters:

serializer - RedisSerializer used to de/serialize keys and value stored in Redis; must not be null.

Returns:

a new RedisSerializationContext using the given RedisSerializer.

just

static <T> RedisSerializationContext<T,T> just(RedisSerializationContext.SerializationPair<T> serializationPair)

Creates a new RedisSerializationContext using the given RedisSerializationContext.SerializationPair.

Type Parameters:

T - Type of Object de/serialized by the RedisSerializationContext.SerializationPair.

Parameters:

serializationPair - RedisSerializationContext.SerializationPair used to de/serialize keys and values stored in Redis; must not be null.

Returns:

a new RedisSerializationContext using the given RedisSerializationContext.SerializationPair.

getKeySerializationPair

RedisSerializationContext.SerializationPair<K> getKeySerializationPair()

Returns:

RedisSerializationContext.SerializationPair for key-typed serialization and deserialization.

getValueSerializationPair

RedisSerializationContext.SerializationPair<V> getValueSerializationPair()

Returns:

RedisSerializationContext.SerializationPair for value-typed serialization and deserialization.

getHashKeySerializationPair

<HK>
RedisSerializationContext.SerializationPair<HK> getHashKeySerializationPair()

Returns:

RedisSerializationContext.SerializationPair for hash-key-typed serialization and deserialization.

getHashValueSerializationPair

<HV>
RedisSerializationContext.SerializationPair<HV> getHashValueSerializationPair()

Returns:

RedisSerializationContext.SerializationPair for hash-value-typed serialization and deserialization.

getStringSerializationPair

RedisSerializationContext.SerializationPair<String> getStringSerializationPair()

Returns:

RedisSerializationContext.SerializationPair for String-typed serialization and deserialization.