org.inferred.freebuilder.processor.util

Class ModelUtils

java.lang.Object

org.inferred.freebuilder.processor.util.ModelUtils

public class ModelUtils
extends java.lang.Object

Utility methods for the javax.lang.model package.

Constructor Summary

Constructors

Constructor and Description
ModelUtils()

Method Summary

Modifier and Type	Method and Description
static javax.lang.model.element.TypeElement	asElement(javax.lang.model.type.DeclaredType type) Returns the TypeElement corresponding to type.
static com.google.common.base.Optional<javax.lang.model.element.AnnotationMirror>	findAnnotationMirror(javax.lang.model.element.Element element, java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass) Returns an AnnotationMirror for the annotation of type annotationClass on element, or Optional.absent() if no such annotation exists.
static com.google.common.base.Optional<javax.lang.model.element.AnnotationMirror>	findAnnotationMirror(javax.lang.model.element.Element element, QualifiedName annotationClass) Returns an AnnotationMirror for the annotation of type annotationClass on element, or Optional.absent() if no such annotation exists.
static com.google.common.base.Optional<javax.lang.model.element.AnnotationMirror>	findAnnotationMirror(javax.lang.model.element.Element element, java.lang.String annotationClassName) Returns an AnnotationMirror for the annotation of type annotationClassName on element, or Optional.absent() if no such annotation exists.
static com.google.common.base.Optional<javax.lang.model.element.AnnotationValue>	findProperty(javax.lang.model.element.AnnotationMirror annotation, java.lang.String propertyName)
static javax.lang.model.type.TypeMirror	getReturnType(javax.lang.model.element.TypeElement type, javax.lang.model.element.ExecutableElement method, javax.lang.model.util.Types types) Determines the return type of method, if called on an instance of type type.
static com.google.common.base.Optional<javax.lang.model.element.TypeElement>	maybeAsTypeElement(javax.lang.model.type.TypeMirror type) Returns the TypeElement corresponding to type, if there is one.
static com.google.common.base.Optional<javax.lang.model.type.DeclaredType>	maybeDeclared(javax.lang.model.type.TypeMirror type) Returns type as a DeclaredType, if it is one.
static com.google.common.base.Optional<javax.lang.model.element.TypeElement>	maybeType(javax.lang.model.element.Element element) Returns element as a TypeElement, if it is one.
static com.google.common.base.Optional<javax.lang.model.type.TypeMirror>	maybeUnbox(javax.lang.model.type.TypeMirror mirror, javax.lang.model.util.Types types) Applies unboxing conversion to mirror, if it can be unboxed.
static com.google.common.base.Optional<javax.lang.model.type.TypeVariable>	maybeVariable(javax.lang.model.type.TypeMirror type)
static boolean	overrides(javax.lang.model.element.TypeElement type, javax.lang.model.util.Types types, java.lang.String methodName, javax.lang.model.type.TypeMirror... params) Returns whether type overrides method methodName(params).

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelUtils

public ModelUtils()

Method Detail

findAnnotationMirror

public static com.google.common.base.Optional<javax.lang.model.element.AnnotationMirror> findAnnotationMirror(javax.lang.model.element.Element element,
                                                                                                              java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Returns an AnnotationMirror for the annotation of type annotationClass on element, or Optional.absent() if no such annotation exists.

findAnnotationMirror

public static com.google.common.base.Optional<javax.lang.model.element.AnnotationMirror> findAnnotationMirror(javax.lang.model.element.Element element,
                                                                                                              QualifiedName annotationClass)

Returns an AnnotationMirror for the annotation of type annotationClass on element, or Optional.absent() if no such annotation exists.

findAnnotationMirror

public static com.google.common.base.Optional<javax.lang.model.element.AnnotationMirror> findAnnotationMirror(javax.lang.model.element.Element element,
                                                                                                              java.lang.String annotationClassName)

Returns an AnnotationMirror for the annotation of type annotationClassName on element, or Optional.absent() if no such annotation exists.

findProperty

public static com.google.common.base.Optional<javax.lang.model.element.AnnotationValue> findProperty(javax.lang.model.element.AnnotationMirror annotation,
                                                                                                     java.lang.String propertyName)

maybeType

public static com.google.common.base.Optional<javax.lang.model.element.TypeElement> maybeType(javax.lang.model.element.Element element)

Returns element as a TypeElement, if it is one.

maybeDeclared

public static com.google.common.base.Optional<javax.lang.model.type.DeclaredType> maybeDeclared(javax.lang.model.type.TypeMirror type)

Returns type as a DeclaredType, if it is one.

maybeVariable

public static com.google.common.base.Optional<javax.lang.model.type.TypeVariable> maybeVariable(javax.lang.model.type.TypeMirror type)

maybeAsTypeElement

public static com.google.common.base.Optional<javax.lang.model.element.TypeElement> maybeAsTypeElement(javax.lang.model.type.TypeMirror type)

Returns the TypeElement corresponding to type, if there is one.

asElement

public static javax.lang.model.element.TypeElement asElement(javax.lang.model.type.DeclaredType type)

Returns the TypeElement corresponding to type.

maybeUnbox

public static com.google.common.base.Optional<javax.lang.model.type.TypeMirror> maybeUnbox(javax.lang.model.type.TypeMirror mirror,
                                                                                           javax.lang.model.util.Types types)

Applies unboxing conversion to mirror, if it can be unboxed.

overrides

public static boolean overrides(javax.lang.model.element.TypeElement type,
                                javax.lang.model.util.Types types,
                                java.lang.String methodName,
                                javax.lang.model.type.TypeMirror... params)

Returns whether type overrides method methodName(params).

getReturnType

public static javax.lang.model.type.TypeMirror getReturnType(javax.lang.model.element.TypeElement type,
                                                             javax.lang.model.element.ExecutableElement method,
                                                             javax.lang.model.util.Types types)

Determines the return type of method, if called on an instance of type type.

For instance, in this example, myY.getProperty() returns List<T>, not T:

    interface X<T> {
      T getProperty();
    }
    @FreeBuilder interface Y<T> extends X<List<T>> { }

(Unfortunately, a bug in Eclipse prevents us handling these cases correctly at the moment. javac works fine.)