Annotation Processor Options
The annotation processor supports several different options that can change the behaviour of the annotation
processor in various ways. Options are typically passed to the javac compiler on the command line using a
syntax -Akey=value although other tools may support slightly different syntax. The table below describes
the options supported by the annotation processor.
| Key | Description |
|---|---|
| sting.debug |
A flag that will enable additional debug output if set to true. This is a useful option when trying
to debug problems related to unresolved injectors.
|
| sting.emit_dot_reports |
A flag that will enable the generation of GraphViz .dot reports if set to true. This is a useful
option when trying to understand complex or large component graphs. See the
GraphViz Integration for further details.
|
| sting.defer.errors |
Setting this option to false will cause Sting to halt at the first error it encounters.
Otherwise Sting will emit the errors as warnings and generate an error when the compile completes. This
is useful when doing full recompiles in code bases that potentially have many errors within them.
|
| sting.defer.unresolved |
Sting will detect whether a type is fully "resolved" before attempting to process the type. A type is
considered unresolved if all types it references exist. This may not be true when a type references
types generated by other annotation processors. This can be disabled by setting this option to
false but this can lead to processor errors and should only be done if this is not a
problem in a particular code base.
|
| sting.verbose_out_of_round.errors |
If code is not being compiled in the current round causes an error to be generated then the supporting
tooling may not be able to link to the source. This primarily impacts integration with some IDEs. As a
result Sting generates more descriptions describing the location of errors including a snippet of the
code that generated the error. This can be disabled by setting this option to false.
|
| sting.emit_json_descriptors |
A flag that will cause the annotation processor to write json descriptors (as well as binary descriptors)
if set to true. This is primarily used when developing Sting.
|
| sting.verify_descriptors |
A flag that will cause the annotation processor to verify binary descriptors after writing the descriptor
if set to true. This is primarily used when developing Sting.
|