checkers.util

Class AnnotationUtils.AnnotationBuilder

@NonNull java.lang.Object

checkers.util.AnnotationUtils.AnnotationBuilder

Enclosing class:

AnnotationUtils

public static class AnnotationUtils.AnnotationBuilder
extends @NonNull 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 build so far Once an annotation is built, no further modification or calls to build can be made. Otherwise, a IllegalStateException. All setter methods throw IllegalArgumentException if the specified element is not found, or that the given value is not a subtype of the expected type. TODO: Doesn't type check arrays yet

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
@Nullable AnnotationMirror	build()
@NonNull ExecutableElement	findElement(CharSequence key)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, @Nullable AnnotationMirror value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, @PolyRead Boolean value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Character value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Class<?> value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Double value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Enum<?> value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Enum<?>[] values)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Float value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Integer value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, List<? extends @NonNull Object> values)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Long value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Object[] values)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, Short value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, @ReadOnly String value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, TypeMirror value)
AnnotationUtils.AnnotationBuilder	setValue(CharSequence elementName, VariableElement value)
AnnotationUtils.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

AnnotationUtils.AnnotationBuilder

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

AnnotationUtils.AnnotationBuilder

public AnnotationUtils.AnnotationBuilder(ProcessingEnvironment env,
                                 CharSequence name)

AnnotationUtils.AnnotationBuilder

public AnnotationUtils.AnnotationBuilder(ProcessingEnvironment env,
                                 @Nullable AnnotationMirror annotation)

Method Detail

build

public @Nullable AnnotationMirror build()

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         @Nullable AnnotationMirror value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         List<? extends @NonNull Object> values)

setValue

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

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         @PolyRead Boolean value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         Character value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         Double value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         Float value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         Integer value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         Long value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         Short value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         @ReadOnly String value)

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         TypeMirror value)

setValue

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

setValue

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

setValue

public AnnotationUtils.AnnotationBuilder setValue(CharSequence elementName,
                                         VariableElement value)

setValue

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

setValue

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

findElement

public @NonNull ExecutableElement findElement(CharSequence key)