org.inferred.testing.model

Class Model

java.lang.Object

org.inferred.testing.model.Model

Direct Known Subclasses:

ModelRule

public class Model
extends Object

Utility class for creating javax.lang.model instances for testing.

The standard javax.lang.model.util objects, and TypeMirror instances for existing classes, are readily available. More complex elements can be constructed from Java source code snippets, allowing top-level types and even code with errors in to be contained within a single test method.

 Model model = create();
 TypeMirror intType = model.typeMirror(java.lang.Class<?>)(int.class);
 TypeElement myType = model.newType(java.lang.String...)(
     "package my.test.package;",
     "public class MyType {",
     "  public void aMethod(int anArg);",
     "}");
 ...
 model.destroy();
 

To save walking the hierarchy of elements to find an inner class, or other element, you can grab any annotatable element with newElementWithMarker(java.lang.String...) (which uses ---> as an easily-spotted element identifier) or newElementAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation>, java.lang.String...) (which uses a user-supplied annotation as the element identifier):

 VariableElement anArg = (VariableElement) model.newElementWithMarker(java.lang.String...)(
     "package my.test.package;",
     "public class MyType2 {",
     "  public void aMethod(---> int anArg);",
     "}");
 ExecutableElement aMethod = (ExecutableElement) model.newElementAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation>, java.lang.String...)(
     Deprecated.class,
     "package my.test.package;",
     "public class MyType3 {",
     "   @Deprecated public void aMethod(int anArg);",
     "}");
 

Constructor Summary

Constructors

Constructor and Description
Model()

Method Summary

Modifier and Type	Method and Description
static Model	create()
void	destroy() Gracefully shuts down the compiler thread.
Elements	elementUtils() Returns a Elements implementation.
ProcessingEnvironment	environment() Returns a ProcessingEnvironment implementation.
Element	newElementAnnotatedWith(Class<? extends Annotation> annotationType, String... code) Parses the supplied code, returning the Element annotated with the given annotation.
Element	newElementWithMarker(String... code) Parses the supplied code, returning the Element marked with "--->".
TypeElement	newType(String... code) Parses the supplied type definition, returning its TypeElement.
protected void	start() Starts up the compiler thread and waits for it to return the processing environment.
TypeElement	typeElement(Class<?> cls) Returns the TypeElement of cls.
TypeElement	typeElement(String qualifiedType) Returns the TypeElement of qualifiedType.
TypeMirror	typeMirror(Class<?> cls) Returns a TypeMirror for the given class (raw T, not T<?>, if T is generic).
TypeMirror	typeMirror(String typeSnippet, TypeMirror... args) Returns a TypeMirror for the given type, substituting any provided arguments for %1, %2, etc.
TypeMirror	typeMirror(com.google.common.reflect.TypeToken<?> type) Returns a TypeMirror for the given type.
Types	typeUtils() Returns a Types implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Model

public Model()

Method Detail

create

public static Model create()

start

protected void start()

Starts up the compiler thread and waits for it to return the processing environment.

typeUtils

public Types typeUtils()

Returns a Types implementation.

elementUtils

public Elements elementUtils()

Returns a Elements implementation.

environment

public ProcessingEnvironment environment()

Returns a ProcessingEnvironment implementation.

typeMirror

public TypeMirror typeMirror(Class<?> cls)

Returns a TypeMirror for the given class (raw T, not T<?>, if T is generic).

typeMirror

public TypeMirror typeMirror(com.google.common.reflect.TypeToken<?> type)

Returns a TypeMirror for the given type.

typeMirror

public TypeMirror typeMirror(String typeSnippet,
                             TypeMirror... args)

Returns a TypeMirror for the given type, substituting any provided arguments for %1, %2, etc. e.g. typeMirror("java.util.List<%1>", typeMirror(String.class)) will return the same thing as typeMirror("java.util.List<java.lang.String>")

Parameters:

typeSnippet - the type, represented as a snippet of Java code, e.g. "java.lang.String", "java.util.Map<%1, %2>"

args - existing TypeMirror instances to be substituted into the type

typeElement

public TypeElement typeElement(Class<?> cls)

Returns the TypeElement of cls.

typeElement

public TypeElement typeElement(String qualifiedType)

Returns the TypeElement of qualifiedType.

newType

public TypeElement newType(String... code)

Parses the supplied type definition, returning its TypeElement.

newElementWithMarker

public Element newElementWithMarker(String... code)

Parses the supplied code, returning the Element marked with "--->". (Only elements that can be annotated in Java can be found this way; the marker is substituted with an annotation internally.)

 Element element = model.newElementWithMarker(
     "interface MyType {",
     "  void myMethod(---> int arg);",
     "}")
 

newElementAnnotatedWith

public Element newElementAnnotatedWith(Class<? extends Annotation> annotationType,
                                       String... code)

Parses the supplied code, returning the Element annotated with the given annotation.

 Element element = model.newElementAnnotatedWith(MyAnnotation.class
     "interface MyType {",
     "  void myMethod(@MyAnnotation int arg);",
     "}")
 

destroy

public void destroy()

Gracefully shuts down the compiler thread.