ball.annotation.processing

Class AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

ball.annotation.processing.AbstractProcessor

All Implemented Interfaces:

JavaLangReflectMethods, Processor

Direct Known Subclasses:

AnnotatedNoAnnotationProcessor, AnnotatedProcessor, NoopProcessor

public abstract class AbstractProcessor
extends AbstractProcessor
implements JavaLangReflectMethods

Extends AbstractProcessor by providing a getSupportedSourceVersion() implementation, methods to report Diagnostic.Kind.ERRORs and Diagnostic.Kind.WARNINGs, and access to ProcessingEnvironment.getFiler(), ProcessingEnvironment.getElementUtils(), and ProcessingEnvironment.getTypeUtils().

Version:

$Revision: 6125 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractProcessor.Check<T extends Element> Abstract AbstractProcessor.Check base class.
protected class	AbstractProcessor.Criterion<T extends Element> Abstract AbstractProcessor.Criterion base class.

Field Summary

Fields

Modifier and Type	Field and Description
protected Elements	elements See ProcessingEnvironment.getElementUtils().
protected Filer	filer See ProcessingEnvironment.getFiler().
protected JavaFileManager	fm JavacTask JavaFileManager instance.
protected JavacTask	javac See JavacTask.instance(ProcessingEnvironment).
protected Trees	trees See Trees.instance(ProcessingEnvironment).
protected Types	types See ProcessingEnvironment.getTypeUtils().

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor()

Method Summary

Modifier and Type	Method and Description
protected TypeElement	asTypeElement(Class<?> type) Method to get a TypeElement for a Class.
protected TypeMirror	asTypeMirror(Class<?> type) Method to get a TypeMirror for a Class.
protected List<TypeMirror>	asTypeMirrorList(Class<?>... types) Method to get a List of TypeMirrors for an array of Classes.
protected AnnotationMirror	getAnnotationMirror(Element element, Class<? extends Annotation> type) Method to get an Element's AnnotationMirror.
protected AnnotationMirror	getAnnotationMirror(Element element, TypeElement type) Method to get an Element's AnnotationMirror.
protected AnnotationValue	getAnnotationValue(AnnotationMirror annotation, String name) Method to get an AnnotationMirror element's AnnotationValue.
protected ClassLoader	getClassPathClassLoader(JavaFileManager fm) See JavaFileManager.getClassLoader(CLASS_PATH).
protected ExecutableElement	getConstructor(TypeElement type, List<TypeMirror> parameters) Constructor to get an ExecutableElement for a Class Constructor by parameter list.
protected ExecutableElement	getMethod(Method method) Method to get an ExecutableElement for a Method prototype.
protected ExecutableElement	getMethod(TypeElement type, Method method) Method to get an ExecutableElement for a Method prototype.
protected String	getPropertyName(ExecutableElement element) Method to get bean property name from an ExecutableElement.
protected Set<String>	getPropertyNames(TypeElement type) Method to get the Set of bean property names for the specified TypeElement.
SourceVersion	getSupportedSourceVersion()
protected Predicate<Element>	hasSameSignatureAs(CharSequence name, Class<?>[] parameters)
protected Predicate<Element>	hasSameSignatureAs(List<TypeMirror> parameters)
protected Predicate<Element>	hasSameSignatureAs(Method method)
protected ExecutableElement	implementationOf(ExecutableElement overridden, TypeElement type) Method to return the ExecutableElement (Method) the argument ExecutableElement is overriden by (if any).
void	init(ProcessingEnvironment processingEnv)
protected Predicate<Element>	isAssignableTo(Class<?> type)
protected Predicate<Element>	isAssignableTo(Class<?> type, Function<? super Element,TypeMirror> extractor)
protected Predicate<Element>	isAssignableTo(TypeMirror type)
protected Predicate<Element>	isAssignableTo(TypeMirror type, Function<? super Element,TypeMirror> extractor)
protected boolean	isEmptyArray(AnnotationValue value) Method to determine if an AnnotationValue is "empty": null or an empty array.
protected boolean	isGetterMethod(ExecutableElement element) Method to determine if an ExecutableElement is a bean getter.
protected Predicate<Element>	named(CharSequence name)
protected ExecutableElement	overrides(ExecutableElement overrider) Method to return the ExecutableElement (Method) the argument ExecutableElement overrides (if any).
protected boolean	overrides(ExecutableElement overrider, ExecutableElement overridden) Method to determine if a ExecutableElement (Method) overrides another ExecutableElement.
protected void	print(Diagnostic.Kind kind, Element element, AnnotationMirror annotation, AnnotationValue value, String format, Object... argv) Method to print a diagnostic message.
protected void	print(Diagnostic.Kind kind, Element element, AnnotationMirror annotation, String format, Object... argv) Method to print a diagnostic message.
protected void	print(Diagnostic.Kind kind, Element element, String format, Object... argv) Method to print a diagnostic message.
protected void	print(Diagnostic.Kind kind, String format, Object... argv) Method to print a diagnostic message.
protected void	print(Diagnostic.Kind kind, Throwable throwable) Method to print a Throwable.
abstract boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected ExecutableElement	specifiedBy(ExecutableElement method) Method to return the ExecutableElement (Method) the argument ExecutableElement is specified by (if any).
protected <E extends Enum<E>> EnumSet<E>	toEnumSet(E[] array)
protected void	whenAnnotationProcessingFinished() Callback method to signal TaskEvent.Kind.ANNOTATION_PROCESSING is finished.
protected <E> Predicate<Element>	with(Set<E> set, Function<Element,Collection<E>> extractor)
protected Predicate<Element>	withModifiers(Modifier... modifiers)
protected Predicate<Element>	withModifiers(Set<Modifier> modifiers)
protected <E> Predicate<Element>	without(Set<E> set, Function<Element,Collection<E>> extractor)
protected Predicate<Element>	withoutModifiers(Modifier... modifiers)
protected Predicate<Element>	withoutModifiers(Set<Modifier> modifiers)
protected Predicate<Element>	withParameters(Class<?>[] parameters)
protected Predicate<Element>	withParameters(List<TypeMirror> parameters)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface ball.lang.reflect.JavaLangReflectMethods

asModifierSet, declaration, declaration, declaration, declaration, declaration, declaration, exceptions, getModifiers, getModifiers, modifiers, parameters, type, type

Field Detail

javac

protected JavacTask javac

See JavacTask.instance(ProcessingEnvironment).

fm

protected JavaFileManager fm

JavacTask JavaFileManager instance.

trees

protected Trees trees

See Trees.instance(ProcessingEnvironment).

filer

protected Filer filer

See ProcessingEnvironment.getFiler().

elements

protected Elements elements

See ProcessingEnvironment.getElementUtils().

types

protected Types types

See ProcessingEnvironment.getTypeUtils().

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

public abstract boolean process(Set<? extends TypeElement> annotations,
                                RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

whenAnnotationProcessingFinished

protected void whenAnnotationProcessingFinished()

Callback method to signal TaskEvent.Kind.ANNOTATION_PROCESSING is finished.

getClassPathClassLoader

protected ClassLoader getClassPathClassLoader(JavaFileManager fm)

See JavaFileManager.getClassLoader(CLASS_PATH).

Parameters:

fm - The JavaFileManager.

Returns:

The ClassLoader.

asTypeElement

protected TypeElement asTypeElement(Class<?> type)

Method to get a TypeElement for a Class.

Parameters:

type - The Class.

Returns:

The TypeElement for the Class.

asTypeMirror

protected TypeMirror asTypeMirror(Class<?> type)

Method to get a TypeMirror for a Class.

Parameters:

type - The Class.

Returns:

The TypeMirror for the Class.

asTypeMirrorList

protected List<TypeMirror> asTypeMirrorList(Class<?>... types)

Method to get a List of TypeMirrors for an array of Classes.

Parameters:

types - The array of Classes.

Returns:

The List of TypeMirrors.

getConstructor

protected ExecutableElement getConstructor(TypeElement type,
                                           List<TypeMirror> parameters)

Constructor to get an ExecutableElement for a Class Constructor by parameter list.

Parameters:

type - The TypeElement.

parameters - The constructor parameter types.

Returns:

The ExecutableElement for the constructor.

getMethod

protected ExecutableElement getMethod(Method method)

Method to get an ExecutableElement for a Method prototype.

Parameters:

method - The prototype Method.

Returns:

The ExecutableElement for the method.

getMethod

protected ExecutableElement getMethod(TypeElement type,
                                      Method method)

Method to get an ExecutableElement for a Method prototype.

Parameters:

type - The TypeElement.

method - The prototype Method.

Returns:

The ExecutableElement for the method.

overrides

protected ExecutableElement overrides(ExecutableElement overrider)

Method to return the ExecutableElement (Method) the argument ExecutableElement overrides (if any).

Parameters:

overrider - The ExecutableElement.

Returns:

The overridden ExecutableElement if any; null otherwise.

See Also:

Elements.overrides(ExecutableElement,ExecutableElement,TypeElement)

overrides

protected boolean overrides(ExecutableElement overrider,
                            ExecutableElement overridden)

Method to determine if a ExecutableElement (Method) overrides another ExecutableElement.

Parameters:

overrider - The (possibly) overriding ExecutableElement.

overridden - The overridden ExecutableElement.

Returns:

true if overrider overrides overridden; false otherwise.

See Also:

Elements.overrides(ExecutableElement,ExecutableElement,TypeElement)

implementationOf

protected ExecutableElement implementationOf(ExecutableElement overridden,
                                             TypeElement type)

Method to return the ExecutableElement (Method) the argument ExecutableElement is overriden by (if any).

Parameters:

overridden - The ExecutableElement.

type - The TypeElement.

Returns:

The overriding ExecutableElement if any; null otherwise.

See Also:

overrides(ExecutableElement)

specifiedBy

protected ExecutableElement specifiedBy(ExecutableElement method)

Method to return the ExecutableElement (Method) the argument ExecutableElement is specified by (if any).

Parameters:

method - The ExecutableElement.

Returns:

The specification ExecutableElement if any; null otherwise.

See Also:

overrides(ExecutableElement)

getAnnotationMirror

protected AnnotationMirror getAnnotationMirror(Element element,
                                               Class<? extends Annotation> type)

Method to get an Element's AnnotationMirror.

Parameters:

element - The annotated Element.

type - The Annotation type (Class).

Returns:

The AnnotationMirror if the Element is annotated with the argument annotation; null otherwise.

See Also:

Element.getAnnotationMirrors()

getAnnotationMirror

protected AnnotationMirror getAnnotationMirror(Element element,
                                               TypeElement type)

Method to get an Element's AnnotationMirror.

Parameters:

element - The annotated Element.

type - The Annotation type (TypeElement).

Returns:

The AnnotationMirror if the Element is annotated with the argument annotation; null otherwise.

See Also:

Element.getAnnotationMirrors()

getAnnotationValue

protected AnnotationValue getAnnotationValue(AnnotationMirror annotation,
                                             String name)

Method to get an AnnotationMirror element's AnnotationValue.

Parameters:

annotation - The AnnotationMirror.

name - The simple name of the element.

Returns:

The AnnotationValue if it is defined; null otherwise.

See Also:

Elements.getElementValuesWithDefaults(AnnotationMirror)

isEmptyArray

protected boolean isEmptyArray(AnnotationValue value)

Method to determine if an AnnotationValue is "empty": null or an empty array.

Parameters:

value - The AnnotationValue.

Returns:

true if empty; {code false} otherwise.

getPropertyName

protected String getPropertyName(ExecutableElement element)

Method to get bean property name from an ExecutableElement.

Parameters:

element - The ExecutableElement.

Returns:

the name String if the ExecutableElement is a getter or setter method; null otherwise.

isGetterMethod

protected boolean isGetterMethod(ExecutableElement element)

Method to determine if an ExecutableElement is a bean getter.

Parameters:

element - The ExecutableElement.

Returns:

true if the Element has a non-private getter method; false otherwise.

getPropertyNames

protected Set<String> getPropertyNames(TypeElement type)

Method to get the Set of bean property names for the specified TypeElement.

Parameters:

type - The TypeElement to analyze.

Returns:

The Set of bean property names.

toEnumSet

protected <E extends Enum<E>> EnumSet<E> toEnumSet(E[] array)

hasSameSignatureAs

protected Predicate<Element> hasSameSignatureAs(List<TypeMirror> parameters)

hasSameSignatureAs

protected Predicate<Element> hasSameSignatureAs(Method method)

hasSameSignatureAs

protected Predicate<Element> hasSameSignatureAs(CharSequence name,
                                                Class<?>[] parameters)

isAssignableTo

protected Predicate<Element> isAssignableTo(Class<?> type)

isAssignableTo

protected Predicate<Element> isAssignableTo(TypeMirror type)

isAssignableTo

protected Predicate<Element> isAssignableTo(Class<?> type,
                                            Function<? super Element,TypeMirror> extractor)

isAssignableTo

protected Predicate<Element> isAssignableTo(TypeMirror type,
                                            Function<? super Element,TypeMirror> extractor)

named

protected Predicate<Element> named(CharSequence name)

withParameters

protected Predicate<Element> withParameters(Class<?>[] parameters)

withParameters

protected Predicate<Element> withParameters(List<TypeMirror> parameters)

withModifiers

protected Predicate<Element> withModifiers(Modifier... modifiers)

withModifiers

protected Predicate<Element> withModifiers(Set<Modifier> modifiers)

withoutModifiers

protected Predicate<Element> withoutModifiers(Modifier... modifiers)

withoutModifiers

protected Predicate<Element> withoutModifiers(Set<Modifier> modifiers)

with

protected <E> Predicate<Element> with(Set<E> set,
                                      Function<Element,Collection<E>> extractor)

without

protected <E> Predicate<Element> without(Set<E> set,
                                         Function<Element,Collection<E>> extractor)

print

protected void print(Diagnostic.Kind kind,
                     String format,
                     Object... argv)

Method to print a diagnostic message.

Parameters:

kind - The Diagnostic.Kind.

format - The message format String.

argv - Optional arguments to the message format String.

See Also:

Messager.printMessage(Diagnostic.Kind,CharSequence)

print

protected void print(Diagnostic.Kind kind,
                     Element element,
                     String format,
                     Object... argv)

Method to print a diagnostic message.

Parameters:

kind - The Diagnostic.Kind.

element - The offending Element.

format - The message format String.

argv - Optional arguments to the message format String.

See Also:

Messager.printMessage(Diagnostic.Kind,CharSequence,Element)

print

protected void print(Diagnostic.Kind kind,
                     Element element,
                     AnnotationMirror annotation,
                     String format,
                     Object... argv)

Method to print a diagnostic message.

Parameters:

kind - The Diagnostic.Kind.

element - The offending Element.

annotation - The offending AnnotationMirror.

format - The message format String.

argv - Optional arguments to the message format String.

See Also:

Messager.printMessage(Diagnostic.Kind,CharSequence,Element,AnnotationMirror)

print

protected void print(Diagnostic.Kind kind,
                     Element element,
                     AnnotationMirror annotation,
                     AnnotationValue value,
                     String format,
                     Object... argv)

Method to print a diagnostic message.

Parameters:

kind - The Diagnostic.Kind.

element - The offending Element.

annotation - The offending AnnotationMirror.

value - The offending AnnotationValue.

format - The message format String.

argv - Optional arguments to the message format String.

See Also:

Messager.printMessage(Diagnostic.Kind,CharSequence,Element,AnnotationMirror,AnnotationValue)

print

protected void print(Diagnostic.Kind kind,
                     Throwable throwable)

Method to print a Throwable.

Parameters:

kind - The Diagnostic.Kind.

throwable - The Throwable.