ball.annotation.processing

Class AbstractProcessor

java.lang.Object

ball.annotation.processing.JavaxLangModelUtilities

ball.annotation.processing.AbstractProcessor

All Implemented Interfaces:

JavaLangReflectMethods, Processor

Direct Known Subclasses:

AnnotatedNoAnnotationProcessor, AnnotatedProcessor, NoopProcessor

public abstract class AbstractProcessor
extends JavaxLangModelUtilities
implements Processor, JavaLangReflectMethods

Provides abstract base class for Processor 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().

Bean Property Summary

Name	Mode	Type	isHidden	isBound	isConstrained
supportedAnnotationTypes	R	Set<String>	false	false	false
supportedOptions	R	Set<String>	false	false	false
supportedSourceVersion	R	SourceVersion	false	false	false

Version:

$Revision: 7479 $

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 Filer	filer See ProcessingEnvironment.getFiler().
protected JavacTask	javac See JavacTask.instance(ProcessingEnvironment).

Fields inherited from class ball.annotation.processing.JavaxLangModelUtilities

elements, fm, MODIFIERS, types

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor()

Method Summary

Modifier and Type	Method and Description
Iterable<? extends Completion>	getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String text)
abstract Set<String>	getSupportedAnnotationTypes()
Set<String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
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 void	whenAnnotationProcessingFinished() Callback method to signal TaskEvent.Kind.ANNOTATION_PROCESSING is finished.

Methods inherited from class ball.annotation.processing.JavaxLangModelUtilities

asClass, asExecutableElement, asExecutableElement, asPackageInfoClass, asTypeElement, asTypeMirror, asTypeMirrorList, asVariableElement, getAnnotationMirror, getAnnotationMirror, getAnnotationValue, getClassLoader, getClassPathClassLoader, getClassPathClassLoader, getConstructor, getEnclosingTypeElement, getMethod, getMethod, getPropertyName, getPropertyNames, getTypeElementFor, hasSameSignatureAs, hasSameSignatureAs, hasSameSignatureAs, implementationOf, isAssignableTo, isAssignableTo, isAssignableTo, isAssignableTo, isEmptyArray, isGetterMethod, named, overrides, overrides, signature, signature, specifiedBy, toEnumSet, toModifiers, with, withModifiers, withModifiers, without, withoutModifiers, withoutModifiers, withParameters, withParameters

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).

filer

protected Filer filer

See ProcessingEnvironment.getFiler().

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

getSupportedOptions

public Set<String> getSupportedOptions()

Specified by:

getSupportedOptions in interface Processor

getSupportedAnnotationTypes

public abstract Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

process

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

Specified by:

process in interface Processor

getCompletions

public Iterable<? extends Completion> getCompletions(Element element,
                                                     AnnotationMirror annotation,
                                                     ExecutableElement member,
                                                     String text)

Specified by:

getCompletions in interface Processor

whenAnnotationProcessingFinished

protected void whenAnnotationProcessingFinished()

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

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.