gson-compile/README.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

# 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`
2022-11-01 10:08:03 +01:00
- Comments via `@GComment`
2022-11-01 11:50:02 +01:00
- Records
- Nested serializable types
2022-11-01 13:48:23 +01:00
- Arrays
2022-11-01 15:08:02 +01:00
- Collections (Sets, Lists, Queues, Deques)
2022-11-01 15:24:59 +01:00
- GPrefer to resolve multiple factories/constructors
## TODO
2022-11-01 15:24:59 +01:00
- Setters/field access in read()
2022-11-01 13:48:23 +01:00
- Maps with string, primitive or enum keys
- Date via ISO8601Utils
- Enums
- Support for nested types from libraries
- Static classes (for configs)
2022-11-01 10:15:29 +01:00
## Credit
The Gson-Compile processor is based on [gsonvalue](https://github.com/evant/gsonvalue) and [value-processor](https://github.com/evant/value-processor) by Eva Tatarka.
The API was inspired by [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization) by Jetbrains
The serialization is powered by [my fork](https://gitlab.com/JFronny/gson-comments) of [gson](https://github.com/google/gson) by Google