Serializer (Ehcache 3 API module 3.10.0 API)

Type Parameters:

T - the type of the instances to serialize

All Known Subinterfaces:

StatefulSerializer<T>
```
public interface Serializer<T>
```
Defines the contract used to transform type instances to and from a serial form.
Implementations must be thread-safe.
When used within the default serialization provider, there is an additional requirement. The implementations must define a constructor that takes in a ClassLoader. The ClassLoader value may be null. If not null, the class loader instance provided should be used during deserialization to load classes needed by the deserialized objects.
The serialized object's class must be preserved; deserialization of the serial form of an object must return an object of the same class. The following contract must always be true:
object.getClass().equals( mySerializer.read(mySerializer.serialize(object)).getClass())

See Also:

SerializationProvider

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`equals(T object, ByteBuffer binary)`	Checks if the given instance and serial form `represent` the same instance.
`T`	`read(ByteBuffer binary)`	Reconstructs an instance from the given serial form.
`ByteBuffer`	`serialize(T object)`	Transforms the given instance into its serial form.

- Method Detail
  - serialize
```
ByteBuffer serialize(T object)
              throws SerializerException
```
    Transforms the given instance into its serial form.
    
    Parameters:
    
    object - the instance to serialize
    
    Returns:
    
    the binary representation of the serial form
    
    Throws:
    
    SerializerException - if serialization fails
  - read
```
T read(ByteBuffer binary)
throws ClassNotFoundException,
       SerializerException
```
    Reconstructs an instance from the given serial form.
    
    Parameters:
    
    binary - the binary representation of the serial form
    
    Returns:
    
    the de-serialized instance
    
    Throws:
    
    SerializerException - if reading the byte buffer fails
    
    ClassNotFoundException - if the type to de-serialize to cannot be found
  - equals
```
boolean equals(T object,
               ByteBuffer binary)
        throws ClassNotFoundException,
               SerializerException
```
    Checks if the given instance and serial form represent the same instance.
    
    Parameters:
    
    object - the instance to check
    
    binary - the serial form to check
    
    Returns:
    
    true if both parameters represent equal instances, false otherwise
    
    Throws:
    
    SerializerException - if reading the byte buffer fails
    
    ClassNotFoundException - if the type to de-serialize to cannot be found