com.bumptech.glide.annotation.compiler

Class GlideAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

com.bumptech.glide.annotation.compiler.GlideAnnotationProcessor

All Implemented Interfaces:

javax.annotation.processing.Processor

@AutoService(value=javax.annotation.processing.Processor.class)
public final class GlideAnnotationProcessor
extends javax.annotation.processing.AbstractProcessor

Generates classes based on Glide's annotations that configure Glide, add support for additional resource types, and/or extend Glide's API.

This processor discovers all AppGlideModule and LibraryGlideModule implementations that are annotated with GlideModule. Any implementations missing the annotation will be ignored.

This processor also discovers all GlideExtension annotated classes.

Multiple classes are generated by this processor:

• For LibraryGlideModules - A GlideIndexer class in a specific package that will later be used by the processor to discover all LibraryGlideModule classes.
• For AppGlideModules - A single AppGlideModule implementation (com.bumptech.glide.GeneratedAppGlideModule) that calls all LibraryGlideModules and the original AppGlideModule in the correct order when Glide is initialized.
• GlideExtensions -
  • A com.bumptech.glide.request.RequestOptions implementation that contains static versions of all builder methods in the base class and both static and instance versions of methods in all GlideExtensions.
  • If one or more methods in one or more GlideExtension annotated classes are annotated with GlideType:
    • A com.bumptech.glide.RequestManager implementation containing a generated method for each method annotated with GlideType.
    • A com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory implementation that produces the generated com.bumptech.glide.RequestManagers.
    • A com.bumptech.glide.Glide look-alike that implements all static methods in the com.bumptech.glide.Glide singleton and returns the generated com.bumptech.glide.RequestManager implementation when appropriate.

AppGlideModule implementations must only be included in applications, not in libraries. There must be exactly one AppGlideModule implementation per Application. The AppGlideModule class is used as a signal that all modules have been found and that the final merged com.bumptech.glide.GeneratedAppGlideModule impl can be created.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
GlideAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
Set<String>	getSupportedAnnotationTypes()
javax.lang.model.SourceVersion	getSupportedSourceVersion()
void	init(javax.annotation.processing.ProcessingEnvironment processingEnvironment)
boolean	process(Set<? extends javax.lang.model.element.TypeElement> set, javax.annotation.processing.RoundEnvironment env) Each round we do the following: Find all AppGlideModules and save them to an instance variable (throw if > 1).

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlideAnnotationProcessor

public GlideAnnotationProcessor()

Method Detail

init

public void init(javax.annotation.processing.ProcessingEnvironment processingEnvironment)

Specified by:

init in interface javax.annotation.processing.Processor

Overrides:

init in class javax.annotation.processing.AbstractProcessor

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface javax.annotation.processing.Processor

Overrides:

getSupportedAnnotationTypes in class javax.annotation.processing.AbstractProcessor

getSupportedSourceVersion

public javax.lang.model.SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface javax.annotation.processing.Processor

Overrides:

getSupportedSourceVersion in class javax.annotation.processing.AbstractProcessor

process

public boolean process(Set<? extends javax.lang.model.element.TypeElement> set,
                       javax.annotation.processing.RoundEnvironment env)

Each round we do the following:

1. Find all AppGlideModules and save them to an instance variable (throw if > 1).
2. Find all LibraryGlideModules
3. For each LibraryGlideModule, write an Indexer with an Annotation with the class name.
4. If we wrote any Indexers, return and wait for the next round.
5. If we didn't write any Indexers and there is a AppGlideModule, write the GeneratedAppGlideModule. Once the GeneratedAppGlideModule is written, we expect to be finished. Any further generation of related classes will result in errors.

Specified by:

process in interface javax.annotation.processing.Processor

Specified by:

process in class javax.annotation.processing.AbstractProcessor