info.archinnov.achilles.internals.apt

Class AptUtils

java.lang.Object

info.archinnov.achilles.internals.apt.AptUtils

public class AptUtils
extends Object

Utility methods for compile time type handling Some methods are borrowed from the Checker Framework : http://types.cs.washington.edu/checker-framework/

Field Summary

Fields

Modifier and Type	Field and Description
Elements	elementUtils
Filer	filer
Messager	messager
Types	typeUtils

Constructor Summary

Constructors

Constructor and Description
AptUtils(Elements elementUtils, Types typeUtils, Messager messager, Filer filer)

Method Summary

Modifier and Type	Method and Description
static String	annotationName(AnnotationMirror annotation)
static boolean	areSameByClass(AnnotationMirror am, Class<? extends Annotation> anno) Checks that the annotation am has the name of anno.
static boolean	areSameByName(AnnotationMirror am, String aname) Checks that the annotation am has the name aname.
static TypeElement	asTypeElement(TypeMirror typeMirror)
static boolean	containsAnnotation(AnnotationTree annotationTree, Class<? extends Annotation> annotationClass)
static boolean	containsAnnotation(Set<Class<? extends Annotation>> annotationMirrors, Class<? extends Annotation> annotationClass)
static boolean	containsElementsAnnotatedBy(Set<? extends TypeElement> typeElements, Class<? extends Annotation> annotationClass)
static long	countElementsAnnotatedBy(Set<? extends TypeElement> typeElements, Class<? extends Annotation> annotationClass)
static TypeElement	enclosingClass(Element elem) Returns the innermost type element enclosing the given element
TypeMirror	erasure(TypeElement typeElement)
TypeMirror	erasure(TypeMirror typeMirror)
com.squareup.javapoet.TypeName	extractTypeArgument(com.squareup.javapoet.TypeName typeName, int argumentIndex)
static Optional<info.archinnov.achilles.type.TypedMap>	extractTypedMap(AnnotationTree annotationTree, Class<? extends Annotation> annotationClass)
static VariableElement	findFieldInType(TypeElement type, String name) Returns the field of the class
ExecutableElement	findGetter(TypeElement classElm, VariableElement elm, List<String> getterNames)
ExecutableElement	findSetter(TypeElement classElm, VariableElement elm, String setterName)
<T extends Annotation> Optional<T>	getAnnotationOnClass(TypeElement typeElement, Class<T> annotationClass)
<T extends Annotation> Optional<T>	getAnnotationOnClass(TypeMirror typeMirror, Class<T> annotationClass) INSTANCE METHODS
static <T> T	getElementValue(AnnotationMirror anno, CharSequence name, Class<T> expectedType, boolean useDefaults) Get the attribute with the name name of the annotation anno.
static <T> List<T>	getElementValueArray(AnnotationMirror anno, CharSequence name, Class<T> expectedType, boolean useDefaults) Get the attribute with the name name of the annotation anno, where the attribute has an array type.
static <T> Optional<Class<T>>	getElementValueClass(AnnotationMirror anno, CharSequence name, boolean useDefaults) Get the Class that is referenced by attribute 'name'.
static Name	getElementValueClassName(AnnotationMirror anno, CharSequence name, boolean useDefaults) Get the Name of the class that is referenced by attribute 'name'.
static <T extends Enum<T>> T	getElementValueEnum(AnnotationMirror anno, CharSequence name, Class<T> t, boolean useDefaults) Version that is suitable for Enum elements.
static Map<ExecutableElement,AnnotationValue>	getElementValuesWithDefaults(AnnotationMirror annotMirror) Returns the values of an annotation's attributes, including defaults.
static List<? extends TypeMirror>	getInterfaces(TypeMirror typeMirror)
static String	getShortname(com.squareup.javapoet.TypeName typeName)
static List<? extends TypeMirror>	getTypeArguments(TypeMirror typeMirror)
static List<TypeElement>	getTypesAnnotatedBy(Set<? extends TypeElement> annotatedTypes, RoundEnvironment roundEnv, Class<? extends Annotation> annotationClass)
static java.util.stream.Stream<TypeElement>	getTypesAnnotatedByAsStream(Set<? extends TypeElement> annotatedTypes, RoundEnvironment roundEnv, Class<? extends Annotation> annotationClass)
static boolean	isAnEnum(Object enumValue)
static boolean	isAnEnum(TypeMirror typeMirror)
static boolean	isAnnotationOfType(TypeElement element, Class<? extends Annotation> annotationClass)
static boolean	isArray(TypeMirror typeMirror)
boolean	isAssignableFrom(Class<?> superClass, TypeMirror typeMirror)
boolean	isCompositeTypeForCassandra(TypeMirror typeMirror)
static boolean	isEclipseCompiler(ExecutableElement executableElement)
static boolean	isEclipseCompiler(TypeElement typeElm)
static boolean	isEclipseCompiler(VariableElement varElm)
static boolean	isJavaCompiler(ExecutableElement executableElement)
static boolean	isJavaCompiler(TypeElement typeElm)
static boolean	isJavaCompiler(VariableElement varElm)
static boolean	isPrimitive(TypeMirror typeMirror)
void	print(Diagnostic.Kind kind, String message, Object... args)
void	printError(String message, Object... args)
void	printMandatoryWarning(String message, Object... args)
void	printNote(String message, Object... args)
void	printWarning(String message, Object... args)
void	validateFalse(boolean condition, String message, Object... params)
void	validateTrue(boolean condition, String message, Object... params)

Methods inherited from class java.lang.Object

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

Field Detail

elementUtils

public final Elements elementUtils

typeUtils

public final Types typeUtils

messager

public final Messager messager

filer

public final Filer filer

Constructor Detail

AptUtils

public AptUtils(Elements elementUtils,
                Types typeUtils,
                Messager messager,
                Filer filer)

Method Detail

isPrimitive

public static boolean isPrimitive(TypeMirror typeMirror)

isArray

public static boolean isArray(TypeMirror typeMirror)

isAnEnum

public static boolean isAnEnum(TypeMirror typeMirror)

isAnEnum

public static boolean isAnEnum(Object enumValue)

getTypeArguments

public static List<? extends TypeMirror> getTypeArguments(TypeMirror typeMirror)

getInterfaces

public static List<? extends TypeMirror> getInterfaces(TypeMirror typeMirror)

containsAnnotation

public static boolean containsAnnotation(Set<Class<? extends Annotation>> annotationMirrors,
                                         Class<? extends Annotation> annotationClass)

countElementsAnnotatedBy

public static long countElementsAnnotatedBy(Set<? extends TypeElement> typeElements,
                                            Class<? extends Annotation> annotationClass)

containsElementsAnnotatedBy

public static boolean containsElementsAnnotatedBy(Set<? extends TypeElement> typeElements,
                                                  Class<? extends Annotation> annotationClass)

containsAnnotation

public static boolean containsAnnotation(AnnotationTree annotationTree,
                                         Class<? extends Annotation> annotationClass)

getTypesAnnotatedBy

public static List<TypeElement> getTypesAnnotatedBy(Set<? extends TypeElement> annotatedTypes,
                                                    RoundEnvironment roundEnv,
                                                    Class<? extends Annotation> annotationClass)

getTypesAnnotatedByAsStream

public static java.util.stream.Stream<TypeElement> getTypesAnnotatedByAsStream(Set<? extends TypeElement> annotatedTypes,
                                                                               RoundEnvironment roundEnv,
                                                                               Class<? extends Annotation> annotationClass)

extractTypedMap

public static Optional<info.archinnov.achilles.type.TypedMap> extractTypedMap(AnnotationTree annotationTree,
                                                                              Class<? extends Annotation> annotationClass)

asTypeElement

public static TypeElement asTypeElement(TypeMirror typeMirror)

isAnnotationOfType

public static boolean isAnnotationOfType(TypeElement element,
                                         Class<? extends Annotation> annotationClass)

areSameByClass

public static boolean areSameByClass(AnnotationMirror am,
                                     Class<? extends Annotation> anno)

Checks that the annotation am has the name of anno. Values are ignored.

areSameByName

public static boolean areSameByName(AnnotationMirror am,
                                    String aname)

Checks that the annotation am has the name aname. Values are ignored.

annotationName

public static final String annotationName(AnnotationMirror annotation)

Returns:

the fully-qualified name of an annotation as a Name

getElementValuesWithDefaults

public static Map<ExecutableElement,AnnotationValue> getElementValuesWithDefaults(AnnotationMirror annotMirror)

Returns the values of an annotation's attributes, including defaults. The method with the same name in JavacElements cannot be used directly, because it includes a cast to Attribute.Compound, which doesn't hold for annotations generated by the Checker Framework.

Parameters:

annotMirror - annotation to examine

Returns:

the values of the annotation's elements, including defaults

See Also:

AnnotationMirror.getElementValues(), JavacElements.getElementValuesWithDefaults(AnnotationMirror)

getElementValue

public static <T> T getElementValue(AnnotationMirror anno,
                                    CharSequence name,
                                    Class<T> expectedType,
                                    boolean useDefaults)

Get the attribute with the name name of the annotation anno. The result is expected to have type expectedType. Note 1: The method does not work well for attributes of an array type (as it would return a list of AnnotationValues). Use getElementValueArray instead. Note 2: The method does not work for attributes of an enum type, as the AnnotationValue is a VarSymbol and would be cast to the enum type, which doesn't work. Use getElementValueEnum instead.

Parameters:

anno - the annotation to disassemble

name - the name of the attribute to access

expectedType - the expected type used to cast the return type

useDefaults - whether to apply default values to the attribute.

Returns:

the value of the attribute with the given name

getElementValueArray

public static <T> List<T> getElementValueArray(AnnotationMirror anno,
                                               CharSequence name,
                                               Class<T> expectedType,
                                               boolean useDefaults)

Get the attribute with the name name of the annotation anno, where the attribute has an array type. One element of the result is expected to have type expectedType. Parameter useDefaults is used to determine whether default values should be used for annotation values. Finding defaults requires more computation, so should be false when no defaulting is needed.

Parameters:

anno - the annotation to disassemble

name - the name of the attribute to access

expectedType - the expected type used to cast the return type

useDefaults - whether to apply default values to the attribute.

Returns:

the value of the attribute with the given name

getElementValueClassName

public static Name getElementValueClassName(AnnotationMirror anno,
                                            CharSequence name,
                                            boolean useDefaults)

Get the Name of the class that is referenced by attribute 'name'. This is a convenience method for the most common use-case. Like getElementValue(anno, name, ClassType.class).getQualifiedName(), but this method ensures consistent use of the qualified name.

getElementValueClass

public static <T> Optional<Class<T>> getElementValueClass(AnnotationMirror anno,
                                                          CharSequence name,
                                                          boolean useDefaults)

Get the Class that is referenced by attribute 'name'. This method uses Class.forName to load the class. It returns null if the class wasn't found.

getElementValueEnum

public static <T extends Enum<T>> T getElementValueEnum(AnnotationMirror anno,
                                                        CharSequence name,
                                                        Class<T> t,
                                                        boolean useDefaults)

Version that is suitable for Enum elements.

enclosingClass

public static TypeElement enclosingClass(Element elem)

Returns the innermost type element enclosing the given element

Parameters:

elem - the enclosed element of a class

Returns:

the innermost type element

findFieldInType

public static VariableElement findFieldInType(TypeElement type,
                                              String name)

Returns the field of the class

isJavaCompiler

public static boolean isJavaCompiler(VariableElement varElm)

isJavaCompiler

public static boolean isJavaCompiler(TypeElement typeElm)

isJavaCompiler

public static boolean isJavaCompiler(ExecutableElement executableElement)

isEclipseCompiler

public static boolean isEclipseCompiler(VariableElement varElm)

isEclipseCompiler

public static boolean isEclipseCompiler(TypeElement typeElm)

isEclipseCompiler

public static boolean isEclipseCompiler(ExecutableElement executableElement)

getShortname

public static String getShortname(com.squareup.javapoet.TypeName typeName)

getAnnotationOnClass

public <T extends Annotation> Optional<T> getAnnotationOnClass(TypeMirror typeMirror,
                                                               Class<T> annotationClass)

INSTANCE METHODS

getAnnotationOnClass

public <T extends Annotation> Optional<T> getAnnotationOnClass(TypeElement typeElement,
                                                               Class<T> annotationClass)

extractTypeArgument

public com.squareup.javapoet.TypeName extractTypeArgument(com.squareup.javapoet.TypeName typeName,
                                                          int argumentIndex)

isAssignableFrom

public boolean isAssignableFrom(Class<?> superClass,
                                TypeMirror typeMirror)

findGetter

public ExecutableElement findGetter(TypeElement classElm,
                                    VariableElement elm,
                                    List<String> getterNames)

findSetter

public ExecutableElement findSetter(TypeElement classElm,
                                    VariableElement elm,
                                    String setterName)

printError

public void printError(String message,
                       Object... args)

printWarning

public void printWarning(String message,
                         Object... args)

printMandatoryWarning

public void printMandatoryWarning(String message,
                                  Object... args)

printNote

public void printNote(String message,
                      Object... args)

print

public void print(Diagnostic.Kind kind,
                  String message,
                  Object... args)

erasure

public TypeMirror erasure(TypeElement typeElement)

erasure

public TypeMirror erasure(TypeMirror typeMirror)

validateTrue

public void validateTrue(boolean condition,
                         String message,
                         Object... params)

validateFalse

public void validateFalse(boolean condition,
                          String message,
                          Object... params)

isCompositeTypeForCassandra

public boolean isCompositeTypeForCassandra(TypeMirror typeMirror)