Annotation Processors

Annotation processing profiles

Item	Keyboard Shortcut	Description
	`Alt+Insert`	Click this button to create a new profile.
	`Alt+Delete`	Click this button to delete the selected profile from the list of existing profiles. All modules, associated with this profile, will be automatically moved to the default profile.
	`F6`	Click this button to associate a module with a profile. This button only becomes available, when a module in the list of modules under a certain profile gets the focus.

Annotation processors settings

Item Description

Enable annotation processing

Item	Description
Enable annotation processing	If you want annotation processors to be run during compilation, select this checkbox and specify associated options: Obtain processors from project classpath: Select this option, if you want IntelliJ IDEA to obtain the annotation processors from the project classpath. This is useful, for example, if you use a custom annotation processor as part of your project, or if the processor is stored in a `.jar` file attached to all the corresponding modules as a library. Processor path: Select this option and specify in the field to the right the path to the annotation processor, if it is not desirable to include the processor into the project or project libraries. Store generated sources relative to: Use the fields below to define where the sources, generated by the annotation processors, are stored, and to override the default behaviour for a profile. Module output directory: By default, the sources generated by annotation processors are stored relative to the module output directory. Module content root: Choose this option to override the default behaviour for a profile. At a later time, if you want to use the generated classes as your own sources, you can mark the corresponding directories as source roots. On rebuild, the directories in which the generated sources are stored will be cleaned up as ordinary output directories. So it is not recommended to store non-generated sources in such directories. Otherwise, the corresponding sources will be lost on rebuild.
Processor FQ Name	Specify the processor fully qualified name. Use (`Alt+Insert`) or (`Alt+Delete`) to make up the list of annotation processors to be run.
Annotation processor options	If necessary, specify the processor run options either as `-key=value`, or `key=value`. Use spaces to separate individual options. Use (`Alt+Insert`) or (`Alt+Delete`) to make up the list of options to be passed to the annotation processors.

If you want annotation processors to be run during compilation, select this checkbox and specify associated options:

Obtain processors from project classpath: Select this option, if you want IntelliJ IDEA to obtain the annotation processors from the project classpath. This is useful, for example, if you use a custom annotation processor as part of your project, or if the processor is stored in a .jar file attached to all the corresponding modules as a library.
Processor path: Select this option and specify in the field to the right the path to the annotation processor, if it is not desirable to include the processor into the project or project libraries.
Store generated sources relative to: Use the fields below to define where the sources, generated by the annotation processors, are stored, and to override the default behaviour for a profile.
- Module output directory: By default, the sources generated by annotation processors are stored relative to the module output directory.
- Module content root: Choose this option to override the default behaviour for a profile.
At a later time, if you want to use the generated classes as your own sources, you can mark the corresponding directories as source roots.

On rebuild, the directories in which the generated sources are stored will be cleaned up as ordinary output directories. So it is not recommended to store non-generated sources in such directories. Otherwise, the corresponding sources will be lost on rebuild.

Processor FQ Name

Specify the processor fully qualified name.

Use (Alt+Insert) or (Alt+Delete) to make up the list of annotation processors to be run.

Annotation processor options

If necessary, specify the processor run options either as -key=value, or key=value.

Use spaces to separate individual options.

Use (Alt+Insert) or (Alt+Delete) to make up the list of options to be passed to the annotation processors.

Last modified: 24 July 2018

IntelliJ IDEA 2018.1 Help

Annotation Processors

Annotation processing profiles

Annotation processors settings

See Also

Procedures: