Class ModelUtils

java.lang.Object

org.inferred.freebuilder.processor.model.ModelUtils

public class ModelUtils
extends Object

Utility methods for the javax.lang.model package.

Field Summary

Fields

Modifier and Type	Field	Description
private static final SimpleTypeVisitor8<Optional<DeclaredType>, ?>	DECLARED_TYPE_VISITOR
private static final SimpleElementVisitor8<Optional<TypeElement>, ?>	TYPE_ELEMENT_VISITOR
private static final SimpleTypeVisitor8<Optional<TypeVariable>, ?>	TYPE_VARIABLE_VISITOR

Constructor Summary

Constructors

Constructor	Description
ModelUtils()

Method Summary

Modifier and Type	Method	Description
static TypeElement	asElement(DeclaredType type)	Returns the TypeElement corresponding to type.
static boolean	erasesToAnyOf(DeclaredType type, Class<?>... possibilities)	Returns true if type erases to any of possibilities.
static boolean	erasesToAnyOf(DeclaredType type, QualifiedName... possibilities)	Returns true if type erases to any of possibilities.
static Optional<AnnotationMirror>	findAnnotationMirror(Element element, Class<? extends Annotation> annotationClass)	Returns an AnnotationMirror for the annotation of type annotationClass on element, or Optional.empty() if no such annotation exists.
static Optional<AnnotationMirror>	findAnnotationMirror(Element element, String annotationClassName)	Returns an AnnotationMirror for the annotation of type annotationClassName on element, or Optional.empty() if no such annotation exists.
static Optional<AnnotationMirror>	findAnnotationMirror(Element element, QualifiedName annotationClass)	Returns an AnnotationMirror for the annotation of type annotationClass on element, or Optional.empty() if no such annotation exists.
static Optional<AnnotationValue>	findProperty(AnnotationMirror annotation, String propertyName)
static TypeMirror	getReturnType(TypeElement type, ExecutableElement method, Types types)	Determines the return type of method, if called on an instance of type type.
static TypeMirror	getReturnType(DeclaredType type, ExecutableElement method, Types types)	Determines the return type of method, if called on an instance of type type.
private static boolean	isPlainWildcard(TypeMirror type)
static Optional<TypeElement>	maybeAsTypeElement(TypeMirror type)	Returns the TypeElement corresponding to type, if there is one.
static Optional<DeclaredType>	maybeDeclared(TypeMirror type)	Returns type as a DeclaredType, if it is one.
static Optional<TypeElement>	maybeType(Element element)	Returns element as a TypeElement, if it is one.
static Optional<TypeMirror>	maybeUnbox(TypeMirror mirror, Types types)	Applies unboxing conversion to mirror, if it can be unboxed.
static Optional<TypeVariable>	maybeVariable(TypeMirror type)
static boolean	needsSafeVarargs(TypeMirror elementType)	Returns true if a method with a variable number of elementType arguments needs a &#64;SafeVarargs annotation to avoid compiler warnings in Java 7+.
static Set<ExecutableElement>	only(Modifier modifier, Set<ExecutableElement> methods)
static Optional<ExecutableElement>	override(TypeElement type, Types types, String methodName, TypeMirror... params)	Returns the method on type that overrides method methodName(params).
static Optional<ExecutableElement>	override(DeclaredType type, Types types, String methodName, TypeMirror... params)	Returns the method on type that overrides method methodName(params).
static boolean	overrides(TypeElement type, Types types, String methodName, TypeMirror... params)	Returns whether type overrides method methodName(params).
static boolean	overrides(DeclaredType type, Types types, String methodName, TypeMirror... params)	Returns whether type overrides method methodName(params).
private static boolean	signatureMatches(ExecutableElement method, Types types, String name, TypeMirror... params)
static TypeMirror	upperBound(Elements elements, TypeMirror type)	Returns the upper bound of type. T -> T ? -> Object ? extends T -> T ? super T -> Object

Methods inherited from class Object

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

Field Details

TYPE_ELEMENT_VISITOR

private static final SimpleElementVisitor8<Optional<TypeElement>, ?> TYPE_ELEMENT_VISITOR

DECLARED_TYPE_VISITOR

private static final SimpleTypeVisitor8<Optional<DeclaredType>, ?> DECLARED_TYPE_VISITOR

TYPE_VARIABLE_VISITOR

private static final SimpleTypeVisitor8<Optional<TypeVariable>, ?> TYPE_VARIABLE_VISITOR

Constructor Details

ModelUtils

public ModelUtils()

Method Details

findAnnotationMirror

public static Optional<AnnotationMirror> findAnnotationMirror(Element element,
 Class<? extends Annotation> annotationClass)

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

findAnnotationMirror

public static Optional<AnnotationMirror> findAnnotationMirror(Element element,
 QualifiedName annotationClass)

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

findAnnotationMirror

public static Optional<AnnotationMirror> findAnnotationMirror(Element element,
 String annotationClassName)

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

findProperty

public static Optional<AnnotationValue> findProperty(AnnotationMirror annotation,
 String propertyName)

maybeType

public static Optional<TypeElement> maybeType(Element element)

Returns element as a TypeElement, if it is one.

maybeDeclared

public static Optional<DeclaredType> maybeDeclared(TypeMirror type)

Returns type as a DeclaredType, if it is one.

maybeVariable

public static Optional<TypeVariable> maybeVariable(TypeMirror type)

maybeAsTypeElement

public static Optional<TypeElement> maybeAsTypeElement(TypeMirror type)

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

asElement

public static TypeElement asElement(DeclaredType type)

Returns the TypeElement corresponding to type.

maybeUnbox

public static Optional<TypeMirror> maybeUnbox(TypeMirror mirror,
 Types types)

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

override

public static Optional<ExecutableElement> override(TypeElement type,
 Types types,
 String methodName,
 TypeMirror... params)

Returns the method on type that overrides method methodName(params).

override

public static Optional<ExecutableElement> override(DeclaredType type,
 Types types,
 String methodName,
 TypeMirror... params)

Returns the method on type that overrides method methodName(params).

overrides

public static boolean overrides(TypeElement type,
 Types types,
 String methodName,
 TypeMirror... params)

Returns whether type overrides method methodName(params).

overrides

public static boolean overrides(DeclaredType type,
 Types types,
 String methodName,
 TypeMirror... params)

Returns whether type overrides method methodName(params).

needsSafeVarargs

public static boolean needsSafeVarargs(TypeMirror elementType)

Returns true if a method with a variable number of elementType arguments needs a @SafeVarargs annotation to avoid compiler warnings in Java 7+.

only

public static Set<ExecutableElement> only(Modifier modifier,
 Set<ExecutableElement> methods)

isPlainWildcard

private static boolean isPlainWildcard(TypeMirror type)

signatureMatches

private static boolean signatureMatches(ExecutableElement method,
 Types types,
 String name,
 TypeMirror... params)

getReturnType

public static TypeMirror getReturnType(TypeElement type,
 ExecutableElement method,
 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.)

getReturnType

public static TypeMirror getReturnType(DeclaredType type,
 ExecutableElement method,
 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.)

upperBound

public static TypeMirror upperBound(Elements elements,
 TypeMirror type)

Returns the upper bound of type.

• T -> T
• ? -> Object
• ? extends T -> T
• ? super T -> Object

erasesToAnyOf

public static boolean erasesToAnyOf(DeclaredType type,
 QualifiedName... possibilities)

Returns true if type erases to any of possibilities.

erasesToAnyOf

public static boolean erasesToAnyOf(DeclaredType type,
 Class<?>... possibilities)

Returns true if type erases to any of possibilities.