gson-compile/README.md

1.2 KiB

Gson-Compile

A java annotation processor implementing automated type adapter generation for gson-comments. The goal of this AP is to

  • Support common features such as getters, setters, fields, constructors
  • Support modern language features such as records
  • Support json5 through gson-comments
  • Be compile-time where possible (ideally compatible with proguard)

Currently supported

  • Primitive types
  • Adapter generation
  • Utility methods
  • Strict no-reflection enforcement via -AgsonCompileNoReflect
  • Comments via @GComment
  • Records
  • Nested serializable types
  • Arrays

TODO

  • Collections (Sets, Lists, Queues, Deques)
  • Maps with string, primitive or enum keys
  • Date via ISO8601Utils
  • Enums
  • Support for nested types from libraries
  • Static classes (for configs)
  • GPrefer to bypass builder/constructor recovery

Credit

The Gson-Compile processor is based on gsonvalue and value-processor by Eva Tatarka. The API was inspired by kotlinx.serialization by Jetbrains The serialization is powered by my fork of gson by Google