Package com.google.auto.value.extension.serializable.serializer.interfaces

Interface SerializerExtension

All Known Implementing Classes:

ImmutableListSerializerExtension, ImmutableMapSerializerExtension, OptionalSerializerExtension

public interface SerializerExtension

A SerializerExtension allows unserializable types to be serialized by SerializableAutoValue.

Extensions are discovered at compile time using the ServiceLoader APIs, allowing them to run without any additional annotations. To be found by ServiceLoader, an extension class must be public with a public no-arg constructor, and its fully-qualified name must appear in a file called META-INF/services/com.google.auto.value.extension.serializable.serializer.interfaces.SerializerExtension in a jar that is on the compiler's -classpath or -processorpath.

When SerializableAutoValue maps each field in an AutoValue to a serializable proxy object, it asks each SerializerExtension whether it can generate code to make the given type serializable. A SerializerExtension replies that it can by returning a non-empty Serializer.

A SerializerExtension is also provided with a SerializerFactory, which it can use to query nested types.

Method Summary

Modifier and Type	Method	Description
Optional<Serializer>	getSerializer(TypeMirror type, SerializerFactory factory, ProcessingEnvironment processingEnv)	Returns a Serializer if this SerializerExtension applies to the given type.

Method Detail

getSerializer

Optional<Serializer> getSerializer(TypeMirror type,
                                   SerializerFactory factory,
                                   ProcessingEnvironment processingEnv)

Returns a Serializer if this SerializerExtension applies to the given type. Otherwise, Optional.empty is returned.

Parameters:

type - the type being serialized

factory - a SerializerFactory that can be used to serialize nested types

processingEnv - the processing environment provided by the annotation processing framework