How to serialize Optional classes with Gson?

by

After several hours of gooling and coding – there is my version:

public class OptionalTypeAdapter<E> extends TypeAdapter<Optional<E>> {

    public static final TypeAdapterFactory FACTORY = new TypeAdapterFactory() {
        @Override
        public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
            Class<T> rawType = (Class<T>) type.getRawType();
            if (rawType != Optional.class) {
                return null;
            }
            final ParameterizedType parameterizedType = (ParameterizedType) type.getType();
            final Type actualType = parameterizedType.getActualTypeArguments()[0];
            final TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(actualType));
            return new OptionalTypeAdapter(adapter);
        }
    };
    private final TypeAdapter<E> adapter;

    public OptionalTypeAdapter(TypeAdapter<E> adapter) {

        this.adapter = adapter;
    }

    @Override
    public void write(JsonWriter out, Optional<E> value) throws IOException {
        if(value.isPresent()){
            adapter.write(out, value.get());
        } else {
            out.nullValue();
        }
    }

    @Override
    public Optional<E> read(JsonReader in) throws IOException {
        final JsonToken peek = in.peek();
        if(peek != JsonToken.NULL){
            return Optional.ofNullable(adapter.read(in));
        }

        in.nextNull();
        return Optional.empty();
    }

}

You can simple registered it with GsonBuilder like this:

instance.registerTypeAdapterFactory(OptionalTypeAdapter.FACTORY)

Please keep attention that Gson does not set values to your class field if field does not present in json. So you need to set default value Optional.empty() in your entity.

More Related Contents:

  1. Gson: How to exclude specific fields from Serialization without annotations
  2. Gson serialize a list of polymorphic objects
  3. Trouble with Gson serializing an ArrayList of POJO’s
  4. Gson Serialize field only if not null or not empty
  5. How do I implement TypeAdapterFactory in Gson?
  6. How do I use Google’s Gson API to deserialize JSON properly?
  7. How to keep fields sequence in Gson serialization
  8. GSON: how to prevent StackOverflowError while keeping circular references?
  9. Parsing a complex Json Object using GSON in Java
  10. GSON does not deserialize reference to outer class
  11. Convert a JSON string to object in Java ME?
  12. JAVA – Best approach to parse huge (extra large) JSON file
  13. gson throws MalformedJsonException
  14. How to parse JSON Array (Not Json Object) in Android
  15. Using Enums while parsing JSON with GSON
  16. Parse JSON file using GSON
  17. Jackson: How to add custom property to the JSON without modifying the POJO
  18. gson.toJson() throws StackOverflowError
  19. Gson: Directly convert String to JsonObject (no POJO)
  20. Jackson – How to process (deserialize) nested JSON?
  21. How to convert a String to JsonObject using gson library
  22. Jackson is not deserialising a generic list that it has serialised
  23. Gson: Is there an easier way to serialize a map
  24. com.google.gson.internal.LinkedTreeMap cannot be cast to my class [duplicate]
  25. Json deserialization into other class hierarchy using Jackson
  26. GSON: How to get a case insensitive element from Json?
  27. Best approach to parse huge (extra large) JSON file
  28. Jackson Serialize Instant to Nanosecond Issue
  29. How to serialize a class with an interface?
  30. Jackson deserialize based on type

Leave a Comment