Johannes
/
gson-compile
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Compile-Time generation of gson adapters
16 Commits 1 Branch 0 Tags 270 KiB
Java 97.8%
Kotlin 2.2%
Go to file
Johannes Frohnmeyer fe2b1fbe24
Parse dates 		2022-11-01 16:58:16 +01:00
gson-compile-annotations Support builders 2022-11-01 15:39:50 +01:00
gson-compile-core Parse dates 2022-11-01 16:58:16 +01:00
gson-compile-example Parse dates 2022-11-01 16:58:16 +01:00
gson-compile-processor Parse dates 2022-11-01 16:58:16 +01:00
.gitignore Support for 1d classes of primitives 2022-10-31 20:52:48 +01:00
LICENSE.md License 2022-11-01 10:15:29 +01:00
README.md Parse dates 2022-11-01 16:58:16 +01:00
build.gradle.kts Support for 1d classes of primitives 2022-10-31 20:52:48 +01:00
settings.gradle.kts Support for 1d classes of primitives 2022-10-31 20:52:48 +01:00

README.md

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)

Supported types

  • Primitives (and boxes)
  • Records
  • Nested serializable types
  • Arrays
  • Collections (Sets, Lists, Queues, Deques)
  • java.util.Date as iso8601

Used properties

Use @GPrefer to choose one construction method if multiple are available

  • Builders (referenced in @GSerializable)
  • Factory functions
  • Constructors
  • Getters/Setters
  • Direct fields (public non-static only)

Additional features

  • Support for generating Gson adapters to hook into the gson system
  • Optional, strict no-reflection enforcement via -AgsonCompileNoReflect
  • Comments via @GComment
  • Several utility methods in the generated class for reading from/writing to various sources

TODO

  • Maps with string, primitive or enum keys
  • Enums
  • Support for nested types from libraries
  • Static classes (for configs)

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