Class AutoAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

com.google.auto.value.processor.AutoAnnotationProcessor

All Implemented Interfaces:

Processor

@AutoService(Processor.class)
@SupportedAnnotationTypes("com.google.auto.value.AutoAnnotation")
public class AutoAnnotationProcessor
extends AbstractProcessor

Javac annotation processor (compiler plugin) to generate annotation implementations. User code never references this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AutoAnnotationProcessor.Member
static class	AutoAnnotationProcessor.Parameter

Field Summary

Fields

Modifier and Type	Field	Description
private Elements	elementUtils
private Types	typeUtils

Fields inherited from class AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
AutoAnnotationProcessor()

Method Summary

Modifier and Type	Method	Description
private AbortProcessingException	abortWithError(String msg, Element e)	Issue a compilation error and return an exception that, when thrown, will cause the processing of this class to be abandoned.
private boolean	compatibleTypes(TypeMirror parameterType, TypeMirror memberType)	Returns true if parameterType can be used to provide the value of an annotation member of type memberType.
private static String	fullyQualifiedName(String pkg, String cls)
private String	generatedClassName(ExecutableElement method)
private TypeElement	getAnnotationReturnType(ExecutableElement method)
private com.google.common.collect.ImmutableMap<String, AnnotationValue>	getDefaultValues(TypeElement annotationElement)
private String	getGeneratedTypeName()
private com.google.common.collect.ImmutableMap<String, ExecutableElement>	getMemberMethods(TypeElement annotationElement)
private com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Member>	getMembers(Element context, com.google.common.collect.ImmutableMap<String, ExecutableElement> memberMethods)
private com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Parameter>	getParameters(TypeElement annotationElement, ExecutableElement method, Map<String, AutoAnnotationProcessor.Member> members)
SourceVersion	getSupportedSourceVersion()
private TypeMirror	getTypeMirror(Class<?> c)
private static Optional<Integer>	invariableHash(List<? extends AnnotationValue> annotationValues)
private static Optional<Integer>	invariableHash(AnnotationValue annotationValue)	Returns the hashCode of the given AnnotationValue, if that hashCode is guaranteed to be always the same.
private static com.google.common.collect.ImmutableMap<String,Integer>	invariableHashes(com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Member> members, com.google.common.collect.ImmutableSet<String> parameters)	Returns a map from the names of members with invariable hashCodes to the values of those hashCodes.
private static boolean	isGwtCompatible(TypeElement annotationElement)
private boolean	methodsAreOverloaded(List<ExecutableElement> methods)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
private void	process(RoundEnvironment roundEnv)
private void	processMethod(ExecutableElement method)
private void	reportError(Element e, String msg, Object... msgParams)	Issue a compilation error.
private void	validateParameters(TypeElement annotationElement, ExecutableElement method, com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Member> members, com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Parameter> parameters, com.google.common.collect.ImmutableMap<String, AnnotationValue> defaultValues)
private Set<Class<?>>	wrapperTypesUsedInCollections(ExecutableElement method)	Returns the wrapper types (Integer.class etc) that are used in collection parameters like List<Integer>.
private void	writeSourceFile(String className, String text, TypeElement originatingType)

Methods inherited from class AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, init, isInitialized

Methods inherited from class Object

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

Field Details

elementUtils

private Elements elementUtils

typeUtils

private Types typeUtils

Constructor Details

AutoAnnotationProcessor

public AutoAnnotationProcessor()

Method Details

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

reportError

private void reportError(Element e,
 String msg,
 Object... msgParams)

Issue a compilation error. This method does not throw an exception, since we want to continue processing and perhaps report other errors.

abortWithError

private AbortProcessingException abortWithError(String msg,
 Element e)

Issue a compilation error and return an exception that, when thrown, will cause the processing of this class to be abandoned. This does not prevent the processing of other classes.

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

process

private void process(RoundEnvironment roundEnv)

processMethod

private void processMethod(ExecutableElement method)

getGeneratedTypeName

private String getGeneratedTypeName()

invariableHash

private static Optional<Integer> invariableHash(AnnotationValue annotationValue)

Returns the hashCode of the given AnnotationValue, if that hashCode is guaranteed to be always the same. The hashCode of a String or primitive type never changes. The hashCode of a Class or an enum constant does potentially change in different runs of the same program. The hashCode of an array doesn't change if the hashCodes of its elements don't. Although we could have a similar rule for nested annotation values, we currently don't.

invariableHash

private static Optional<Integer> invariableHash(List<? extends AnnotationValue> annotationValues)

invariableHashes

private static com.google.common.collect.ImmutableMap<String,Integer> invariableHashes(com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Member> members,
 com.google.common.collect.ImmutableSet<String> parameters)

Returns a map from the names of members with invariable hashCodes to the values of those hashCodes.

methodsAreOverloaded

private boolean methodsAreOverloaded(List<ExecutableElement> methods)

generatedClassName

private String generatedClassName(ExecutableElement method)

getAnnotationReturnType

private TypeElement getAnnotationReturnType(ExecutableElement method)

getMemberMethods

private com.google.common.collect.ImmutableMap<String, ExecutableElement> getMemberMethods(TypeElement annotationElement)

getMembers

private com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Member> getMembers(Element context,
 com.google.common.collect.ImmutableMap<String, ExecutableElement> memberMethods)

getDefaultValues

private com.google.common.collect.ImmutableMap<String, AnnotationValue> getDefaultValues(TypeElement annotationElement)

getParameters

private com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Parameter> getParameters(TypeElement annotationElement,
 ExecutableElement method,
 Map<String, AutoAnnotationProcessor.Member> members)

validateParameters

private void validateParameters(TypeElement annotationElement,
 ExecutableElement method,
 com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Member> members,
 com.google.common.collect.ImmutableMap<String, AutoAnnotationProcessor.Parameter> parameters,
 com.google.common.collect.ImmutableMap<String, AnnotationValue> defaultValues)

compatibleTypes

private boolean compatibleTypes(TypeMirror parameterType,
 TypeMirror memberType)

Returns true if parameterType can be used to provide the value of an annotation member of type memberType. They must either be the same type, or the member type must be an array and the parameter type must be a collection of a compatible type.

wrapperTypesUsedInCollections

private Set<Class<?>> wrapperTypesUsedInCollections(ExecutableElement method)

Returns the wrapper types (Integer.class etc) that are used in collection parameters like List<Integer>. This is needed because we will emit a helper method for each such type, for example to convert Collection<Integer> into int[].

getTypeMirror

private TypeMirror getTypeMirror(Class<?> c)

isGwtCompatible

private static boolean isGwtCompatible(TypeElement annotationElement)

fullyQualifiedName

private static String fullyQualifiedName(String pkg,
 String cls)

writeSourceFile

private void writeSourceFile(String className,
 String text,
 TypeElement originatingType)