Package io.datarouter.gson.typeadapterfactory

Class EnumTypeAdapterFactory

java.lang.Object

io.datarouter.gson.typeadapterfactory.EnumTypeAdapterFactory

All Implemented Interfaces:

com.google.gson.TypeAdapterFactory

Direct Known Subclasses:

EnumTypeAdapterFactory.AnonymousAllowUnregisteredEnumTypeAdapterFactory, EnumTypeAdapterFactory.RejectAllEnumTypeAdapterFactory

public abstract class EnumTypeAdapterFactory
extends Object
implements com.google.gson.TypeAdapterFactory

Intercepts all enum serialization, preventing accidental serialization of enums without explicitly specifying an encoding. This will reject unknown enums by default but can allow them by setting allowUnregistered()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumTypeAdapterFactory.AnonymousAllowUnregisteredEnumTypeAdapterFactory	This can be used to intercept and log unregistered enums, however when multiple of these exist, the logs will not differentiate between them.
static class	EnumTypeAdapterFactory.RejectAllEnumTypeAdapterFactory

Constructor Summary

Constructors

Constructor	Description
EnumTypeAdapterFactory()

Method Summary

Modifier and Type	Method	Description
protected EnumTypeAdapterFactory	allowUnregistered()	Not recommended.
<T> com.google.gson.TypeAdapter<T>	create(com.google.gson.Gson gson, com.google.gson.reflect.TypeToken<T> type)
protected <T> EnumTypeAdapterFactory	register(Class<T> cls, com.google.gson.TypeAdapter<T> typeAdapter)
protected <T extends Enum<T>> EnumTypeAdapterFactory	registerStringMappedEnumOptional(io.datarouter.enums.MappedEnum<T,String> mappedEnum, T replacement)
protected <T extends Enum<T>> EnumTypeAdapterFactory	registerStringMappedEnumOptionalWithLogging(io.datarouter.enums.MappedEnum<T,String> mappedEnum, T replacement)
protected <T extends Enum<T>> EnumTypeAdapterFactory	registerStringMappedEnumRequired(io.datarouter.enums.MappedEnum<T,String> mappedEnum)
protected EnumTypeAdapterFactory	suppressUnregisteredLogging()	Not recommended.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnumTypeAdapterFactory

public EnumTypeAdapterFactory()

Method Details

allowUnregistered

protected EnumTypeAdapterFactory allowUnregistered()

Not recommended. Instead of throwing an exception for unregistered Enum types, let Gson serialize by enum.name() or annotation

suppressUnregisteredLogging

protected EnumTypeAdapterFactory suppressUnregisteredLogging()

Not recommended. Suppress the warning logs when unregistered enums are encountered, for cases where the enums can't be known about ahead of time.

register

protected <T> EnumTypeAdapterFactory register(Class<T> cls,
 com.google.gson.TypeAdapter<T> typeAdapter)

registerStringMappedEnumRequired

protected <T extends Enum<T>>
EnumTypeAdapterFactory registerStringMappedEnumRequired(io.datarouter.enums.MappedEnum<T,String> mappedEnum)

registerStringMappedEnumOptional

protected <T extends Enum<T>>
EnumTypeAdapterFactory registerStringMappedEnumOptional(io.datarouter.enums.MappedEnum<T,String> mappedEnum,
 T replacement)

registerStringMappedEnumOptionalWithLogging

protected <T extends Enum<T>>
EnumTypeAdapterFactory registerStringMappedEnumOptionalWithLogging(io.datarouter.enums.MappedEnum<T,String> mappedEnum,
 T replacement)

create

public <T> com.google.gson.TypeAdapter<T> create(com.google.gson.Gson gson,
 com.google.gson.reflect.TypeToken<T> type)

Specified by:

create in interface com.google.gson.TypeAdapterFactory