OpenJDK 27 · javax.annotation.processing · APIdia, the JavaDoc alternative

Facilities for declaring annotation processors and for allowing annotation processors to communicate with an annotation processing tool environment.

Unless otherwise specified in a particular implementation, the collections returned by methods in this package should be expected to be unmodifiable by the caller and unsafe for concurrent access.

Unless otherwise specified, methods in this package will throw a NullPointerException if given a null argument.

Interface Summary

Modifier and Type	Interface and Description
public interface	Completion A suggested completion for an annotation.
public interface	Filer This interface supports the creation of new files by an annotation processor.
public interface	Messager A `Messager` provides the way for an annotation processor to report error messages, warnings, and other notices.
public interface	ProcessingEnvironment An annotation processing tool framework will provide an annotation processor with an object implementing this interface so the processor can use facilities provided by the framework to write new files, report error messages, and find other utilities.
public interface	Processor The interface for an annotation processor.
public interface	RoundEnvironment An annotation processing tool framework will provide an annotation processor with an object implementing this interface so that the processor can query for information about a round of annotation processing.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	Generated The Generated annotation is used to mark source code that has been generated.
public @interface	SupportedAnnotationTypes An annotation used to indicate what annotation interfaces an annotation processor supports.
public @interface	SupportedOptions An annotation used to indicate what options an annotation processor supports.
public @interface	SupportedSourceVersion An annotation used to indicate the latest source version an annotation processor supports.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractProcessor An abstract annotation processor designed to be a convenient superclass for most concrete annotation processors.
public class	Completions Utility class for assembling `Completion` objects.
public class	FilerException Indicates a `Filer` detected an attempt to open a file that would violate the guarantees provided by the `Filer`.

Package javax.annotation.processing

Interface Summary

Annotation Summary

Class Summary