dagger.hilt.processor.internal.root

Class RootProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

dagger.hilt.processor.internal.BaseProcessor

dagger.hilt.processor.internal.root.RootProcessor

All Implemented Interfaces:

javax.annotation.processing.Processor

@IncrementalAnnotationProcessor(value=AGGREGATING)
 @AutoService(value=javax.annotation.processing.Processor.class)
public final class RootProcessor
extends BaseProcessor

Processor that outputs dagger components based on transitive build deps.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
RootProcessor()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<java.lang.String>	getSupportedAnnotationTypes()
void	init(javax.annotation.processing.ProcessingEnvironment processingEnvironment)
void	postRoundProcess(javax.annotation.processing.RoundEnvironment roundEnv) Used to perform post processing at the end of a round.
void	processEach(javax.lang.model.element.TypeElement annotation, javax.lang.model.element.Element element) Called for each element in a round that uses a supported annotation.

Methods inherited from class dagger.hilt.processor.internal.BaseProcessor

claimAnnotations, delayErrors, getElementUtils, getErrorHandler, getMessager, getProcessingEnv, getSupportedSourceVersion, getTypeUtils, preRoundProcess, process

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

RootProcessor

public RootProcessor()

Method Detail

init

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

Specified by:

init in interface javax.annotation.processing.Processor

Overrides:

init in class BaseProcessor

getSupportedAnnotationTypes

public com.google.common.collect.ImmutableSet<java.lang.String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface javax.annotation.processing.Processor

Overrides:

getSupportedAnnotationTypes in class javax.annotation.processing.AbstractProcessor

processEach

public void processEach(javax.lang.model.element.TypeElement annotation,
                        javax.lang.model.element.Element element)
                 throws java.lang.Exception

Description copied from class: BaseProcessor

Called for each element in a round that uses a supported annotation. Note that an exception can be thrown for each element in the round. This is usually preferred over throwing only the first exception in a round. Only throwing the first exception in the round can lead to flaky errors that are dependent on the non-deterministic ordering that the elements are processed in.

Overrides:

processEach in class BaseProcessor

Throws:

java.lang.Exception

postRoundProcess

public void postRoundProcess(javax.annotation.processing.RoundEnvironment roundEnv)
                      throws java.lang.Exception

Description copied from class: BaseProcessor

Used to perform post processing at the end of a round. This is especially useful for handling additional processing that depends on aggregate data, that cannot be handled in #processEach().

Note: this will not be called if an exception is thrown during #processEach() -- if we have already detected errors on an annotated element, performing post processing on an aggregate will just produce more (perhaps non-deterministic) errors.

Overrides:

postRoundProcess in class BaseProcessor

Throws:

java.lang.Exception