Class AutoServiceProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

com.google.auto.service.processor.AutoServiceProcessor

All Implemented Interfaces:

Processor

@SupportedOptions({"debug","verify"})
public class AutoServiceProcessor
extends AbstractProcessor

Processes AutoService annotations and generates the service provider configuration files described in ServiceLoader.

Processor Options:

• -Adebug - turns on debug statements
• -Averify=true - turns on extra verification

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	MISSING_SERVICES_ERROR
private final com.google.common.collect.Multimap<String,String>	providers	Maps the class names of service provider interfaces to the class names of the concrete classes which implement them.

Fields inherited from class AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
AutoServiceProcessor()

Method Summary

Modifier and Type	Method	Description
private boolean	checkImplementer(TypeElement providerImplementer, TypeElement providerType, AnnotationMirror annotationMirror)	Verifies invalid reference ServiceProvider constraints on the concrete provider class.
private void	error(String msg, Element element, AnnotationMirror annotation)
private void	fatalError(String msg)
private void	generateConfigFiles()
private String	getBinaryName(TypeElement element)	Returns the binary name of a reference type.
private String	getBinaryNameImpl(TypeElement element, String className)
com.google.common.collect.ImmutableSet<String>	getSupportedAnnotationTypes()
SourceVersion	getSupportedSourceVersion()
private com.google.common.collect.ImmutableSet<DeclaredType>	getValueFieldOfClasses(AnnotationMirror annotationMirror)	Returns the contents of a Class[]-typed "value" field in a given annotationMirror.
private void	log(String msg)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)	For each class annotated with AutoService Verify the AutoService interface value is correct Categorize the class by its service interface For each AutoService interface Create a file named META-INF/services/<interface> For each AutoService annotated class for this interface Create an entry in the file
private void	processAnnotations(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private void	processImpl(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private static boolean	rawTypesSuppressed(Element element)
private void	warning(String msg, Element element, AnnotationMirror annotation)

Methods inherited from class AbstractProcessor

getCompletions, getSupportedOptions, init, isInitialized

Methods inherited from class Object

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

Field Details

MISSING_SERVICES_ERROR

static final String MISSING_SERVICES_ERROR

See Also:

• Constant Field Values

providers

private final com.google.common.collect.Multimap<String,String> providers

Maps the class names of service provider interfaces to the class names of the concrete classes which implement them.

For example, "com.google.apphosting.LocalRpcService" -> "com.google.apphosting.datastore.LocalDatastoreService"

Constructor Details

AutoServiceProcessor

public AutoServiceProcessor()

Method Details

getSupportedAnnotationTypes

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

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class AbstractProcessor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

1. For each class annotated with AutoService
   • Verify the AutoService interface value is correct
   • Categorize the class by its service interface
2. For each AutoService interface
   • Create a file named META-INF/services/<interface>
   • For each AutoService annotated class for this interface
     • Create an entry in the file

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

processImpl

private void processImpl(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

processAnnotations

private void processAnnotations(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

generateConfigFiles

private void generateConfigFiles()

checkImplementer

private boolean checkImplementer(TypeElement providerImplementer,
 TypeElement providerType,
 AnnotationMirror annotationMirror)

Verifies

invalid reference

ServiceProvider

constraints on the concrete provider class. Note that these constraints are enforced at runtime via the ServiceLoader, we're just checking them at compile time to be extra nice to our users.

rawTypesSuppressed

private static boolean rawTypesSuppressed(Element element)

getBinaryName

private String getBinaryName(TypeElement element)

Returns the binary name of a reference type. For example, com.google.Foo$Bar, instead of com.google.Foo.Bar.

getBinaryNameImpl

private String getBinaryNameImpl(TypeElement element,
 String className)

getValueFieldOfClasses

private com.google.common.collect.ImmutableSet<DeclaredType> getValueFieldOfClasses(AnnotationMirror annotationMirror)

Returns the contents of a Class[]-typed "value" field in a given annotationMirror.

log

private void log(String msg)

warning

private void warning(String msg,
 Element element,
 AnnotationMirror annotation)

error

private void error(String msg,
 Element element,
 AnnotationMirror annotation)

fatalError

private void fatalError(String msg)