blob: e56e4e8dfa6544b22a486a3b6ceb39090b20da0c [file] [view]
# Fory Annotation Processor
`fory-annotation-processor` generates static serializers for Java classes annotated with
`@ForyStruct`. The serializers are generated by javac during the application build, so they can be
used when runtime serializer generation is disabled or unavailable.
Use this processor for:
- Android applications.
- ordinary JVM applications using `ForyBuilder#withCodegen(false)`.
- Android model classes that use Fory type-use annotations such as `@Ref`, `@UInt8Type`, or
`@Float16Type`.
For GraalVM native images, use Fory's GraalVM native-image build-time serializer generation instead.
## Ownership
The processor is an opt-in build tool. Applications add it to their annotation-processor path; it
emits Java source that references `fory-core` runtime APIs. `fory-core` does not depend on this
module, and the processor implementation does not need a compile-time dependency on `fory-core`.
For the full user-facing guide, see
[`docs/guide/java/static-generated-serializers.md`](../../docs/guide/java/static-generated-serializers.md).