checkers.source

Class AggregateChecker

java.lang.Object

javax.annotation.processing.AbstractProcessor

checkers.source.AbstractTypeProcessor

checkers.source.AggregateChecker

All Implemented Interfaces:

Processor

Direct Known Subclasses:

I18nChecker, NullnessChecker, OIGJChecker

public abstract class AggregateChecker
extends AbstractTypeProcessor

An aggregate checker that packages multiple checkers together. The resulting checker invokes the individual checkers together on the processed files. This class delegates AbstractTypeProcessor responsibilities to each of the checkers. Checker writers need to subclass this class and only override getSupportedCheckers() to indicate the classes of the checkers to be bundled.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SourceChecker>	checkers

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AggregateChecker()

Method Summary

Methods

Modifier and Type	Method and Description
Set<@ReadOnly String>	getSupportedAnnotationTypes()
protected abstract Collection<Class<? extends SourceChecker>>	getSupportedCheckers() Returns the list of supported checkers to be run together.
Set<@ReadOnly String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment env) Register a TaskListener that will get called after FLOW.
void	typeProcess(TypeElement element, @Nullable TreePath tree) Processes a fully analyzed class that contains a supported annotation (look AbstractProcessor.getSupportedAnnotationTypes()).
void	typeProcessingOver() A method to be called once all the classes are processed and no error is reported.
void	typeProcessingStart() A method to be called once before the first call to typeProcess.

Methods inherited from class checkers.source.AbstractTypeProcessor

process

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized, toString

Methods inherited from class java.lang.Object

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

Field Detail

checkers

protected List<SourceChecker> checkers

Constructor Detail

AggregateChecker

public AggregateChecker()

Method Detail

getSupportedCheckers

protected abstract Collection<Class<? extends SourceChecker>> getSupportedCheckers()

Returns the list of supported checkers to be run together. Subclasses need to override this method.

init

public final void init(ProcessingEnvironment env)

Description copied from class: AbstractTypeProcessor

Register a TaskListener that will get called after FLOW.

Specified by:

init in interface Processor

Overrides:

init in class AbstractTypeProcessor

typeProcessingStart

public void typeProcessingStart()

Description copied from class: AbstractTypeProcessor

A method to be called once before the first call to typeProcess.

Subclasses may override this method to do any initialization work.

Overrides:

typeProcessingStart in class AbstractTypeProcessor

typeProcess

public final void typeProcess(TypeElement element,
               @Nullable TreePath tree)

Description copied from class: AbstractTypeProcessor

Processes a fully analyzed class that contains a supported annotation (look AbstractProcessor.getSupportedAnnotationTypes()).

The passed class is always valid type-checked Java code.

Specified by:

typeProcess in class AbstractTypeProcessor

Parameters:

element - element of the analyzed class

tree - the tree path to the element, with the leaf being a ClassTree

typeProcessingOver

public void typeProcessingOver()

Description copied from class: AbstractTypeProcessor

A method to be called once all the classes are processed and no error is reported.

Subclasses may override this method to do any aggregate analysis (e.g. generate report, persistence) or resource deallocation.

If an error (a Java error or a processor error) is reported, this method is not guaranteed to be invoked.

Overrides:

typeProcessingOver in class AbstractTypeProcessor

getSupportedOptions

public final Set<@ReadOnly String> getSupportedOptions()

Specified by:

getSupportedOptions in interface Processor

Overrides:

getSupportedOptions in class AbstractProcessor

getSupportedAnnotationTypes

public final Set<@ReadOnly String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class AbstractProcessor

getSupportedSourceVersion

public final SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor