org.ehcache.spi.serialization
Interface SerializationProvider

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultJsr107SerializationProvider, DefaultSerializationProvider

public interface SerializationProvider
extends Service

Contract to provide a Serializer for a given type.

Method Summary

<T> Serializer<T>	createKeySerializer(java.lang.Class<T> clazz, java.lang.ClassLoader classLoader, ServiceConfiguration<?>... configs) Creates a key Serializer with the given parameters.
<T> Serializer<T>	createValueSerializer(java.lang.Class<T> clazz, java.lang.ClassLoader classLoader, ServiceConfiguration<?>... configs) Creates a value Serializer with the given parameters.
void	releaseSerializer(Serializer<?> serializer) Releases the given Serializer instance

Methods inherited from interface org.ehcache.spi.service.Service

start, stop

Method Detail

createKeySerializer

<T> Serializer<T> createKeySerializer(java.lang.Class<T> clazz,
                                      java.lang.ClassLoader classLoader,
                                      ServiceConfiguration<?>... configs)
                                  throws UnsupportedTypeException

Creates a key Serializer with the given parameters.

Type Parameters:

T - the type serialized to serialize to/from

Parameters:

clazz - the class of the type to serialize to/from

classLoader - the classloader to use

configs - specific configuration

Returns:

a Serializer instance

Throws:

UnsupportedTypeException - if a serializer cannot be created for the given type

createValueSerializer

<T> Serializer<T> createValueSerializer(java.lang.Class<T> clazz,
                                        java.lang.ClassLoader classLoader,
                                        ServiceConfiguration<?>... configs)
                                    throws UnsupportedTypeException

Creates a value Serializer with the given parameters.

Type Parameters:

T - the type serialized to serialize to/from

Parameters:

clazz - the class of the type to serialize to/from

classLoader - the classloader to use

configs - specific configuration

Returns:

a Serializer instance

Throws:

UnsupportedTypeException - if a serializer cannot be created for the given type

releaseSerializer

void releaseSerializer(Serializer<?> serializer)
                       throws java.lang.Exception

Releases the given Serializer instance

Parameters:

serializer - the serializer to be released

Throws:

java.lang.Exception - when the release fails