org.checkerframework.javacutil

Class AnnotationBuilder

java.lang.Object

org.checkerframework.javacutil.AnnotationBuilder

public class AnnotationBuilder
extends Object

Builds an annotation mirror that may have some values.

Constructing an AnnotationMirror requires:

1. Constructing the builder with the desired annotation class
2. Setting each value individually using setValue methods
3. Calling build() to get the annotation

Once an annotation is built, no further modification or calls to build can be made. Otherwise, a IllegalStateException is thrown.

All setter methods throw IllegalArgumentException if the specified element is not found, or if the given value is not a subtype of the expected type.

TODO: Doesn't type-check arrays yet

Constructor Summary

Constructors

Constructor and Description
AnnotationBuilder(ProcessingEnvironment env, AnnotationMirror annotation)
AnnotationBuilder(ProcessingEnvironment env, CharSequence name)
AnnotationBuilder(ProcessingEnvironment env, Class<? extends Annotation> anno)

Method Summary

Modifier and Type	Method and Description
AnnotationMirror	build()
static void	clear()
void	copyElementValuesFromAnnotation(AnnotationMirror valueHolder, String... ignorableElements) Copies every element value from the given annotation.
void	copyRenameElementValuesFromAnnotation(AnnotationMirror valueHolder, Map<String,String> elementNameRenaming) Copies the specified element values from the given annotation, using the specified renaming map.
ExecutableElement	findElement(CharSequence key)
static AnnotationMirror	fromClass(Elements elements, Class<? extends Annotation> clazz) Creates an AnnotationMirror given by a particular annotation class.
static AnnotationMirror	fromName(Elements elements, CharSequence name) Creates an AnnotationMirror given by a particular fully-qualified name.
AnnotationBuilder	setValue(CharSequence elementName, AnnotationMirror value)
AnnotationBuilder	setValue(CharSequence elementName, Boolean value)
AnnotationBuilder	setValue(CharSequence elementName, Character value)
AnnotationBuilder	setValue(CharSequence elementName, Class<?> value)
AnnotationBuilder	setValue(CharSequence elementName, Double value)
AnnotationBuilder	setValue(CharSequence elementName, Enum<?> value)
AnnotationBuilder	setValue(CharSequence elementName, Enum<?>[] values)
AnnotationBuilder	setValue(CharSequence elementName, Float value)
AnnotationBuilder	setValue(CharSequence elementName, Integer value)
AnnotationBuilder	setValue(CharSequence elementName, List<? extends Object> values)
AnnotationBuilder	setValue(CharSequence elementName, Long value)
AnnotationBuilder	setValue(CharSequence elementName, Object[] values)
AnnotationBuilder	setValue(CharSequence elementName, Short value)
AnnotationBuilder	setValue(CharSequence elementName, String value)
AnnotationBuilder	setValue(CharSequence elementName, TypeMirror value)
AnnotationBuilder	setValue(CharSequence elementName, VariableElement value)
AnnotationBuilder	setValue(CharSequence elementName, VariableElement[] values)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationBuilder

public AnnotationBuilder(ProcessingEnvironment env,
                         Class<? extends Annotation> anno)

AnnotationBuilder

public AnnotationBuilder(ProcessingEnvironment env,
                         CharSequence name)

AnnotationBuilder

public AnnotationBuilder(ProcessingEnvironment env,
                         AnnotationMirror annotation)

Method Detail

fromClass

public static AnnotationMirror fromClass(Elements elements,
                                         Class<? extends Annotation> clazz)

Creates an AnnotationMirror given by a particular annotation class.

Parameters:

elements - the element utilities to use

clazz - the annotation class

Returns:

an AnnotationMirror of type given type

fromName

public static AnnotationMirror fromName(Elements elements,
                                        CharSequence name)

Creates an AnnotationMirror given by a particular fully-qualified name. getElementValues on the result returns an empty map.

Parameters:

elements - the element utilities to use

name - the name of the annotation to create

Returns:

an AnnotationMirror of type name

clear

public static void clear()

build

public AnnotationMirror build()

copyElementValuesFromAnnotation

public void copyElementValuesFromAnnotation(AnnotationMirror valueHolder,
                                            String... ignorableElements)

Copies every element value from the given annotation. If an element in the given annotation doesn't exist in the annotation to be built, an error is raised unless the element is specified in ignorableElements.

Parameters:

valueHolder - the annotation that holds the values to be copied

ignorableElements - the elements that can be safely dropped

copyRenameElementValuesFromAnnotation

public void copyRenameElementValuesFromAnnotation(AnnotationMirror valueHolder,
                                                  Map<String,String> elementNameRenaming)

Copies the specified element values from the given annotation, using the specified renaming map. Each value in the map must be an element name in the annotation being built. If an element from the given annotation is not a key in the map, it is ignored.

Parameters:

valueHolder - the annotation that holds the values to be copied

elementNameRenaming - a map from element names in valueHolder to element names of the annotation being built

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  AnnotationMirror value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  List<? extends Object> values)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Object[] values)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Boolean value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Character value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Double value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Float value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Integer value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Long value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Short value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  String value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  TypeMirror value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Class<?> value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Enum<?> value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  VariableElement value)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  Enum<?>[] values)

setValue

public AnnotationBuilder setValue(CharSequence elementName,
                                  VariableElement[] values)

findElement

public ExecutableElement findElement(CharSequence key)