Package ball.annotation.processing

Class AnnotatedProcessor

java.lang.Object

ball.annotation.processing.JavaxLangModelUtilities

ball.annotation.processing.AbstractProcessor

ball.annotation.processing.AnnotatedProcessor

All Implemented Interfaces:

JavaLangReflectMethods, Processor

Direct Known Subclasses:

AnnotationValueMustConvertTo.ProcessorImpl, AntLibProcessor, AntTaskAttributeConstraintProcessor, AntTaskProcessor, CompileTimeCheckProcessor, ConstantValueMustConvertToProcessor, ConstructorPropertiesProcessor, For.ProcessorImpl, ForElementKinds.ProcessorImpl, ForSubclassesOf.ProcessorImpl, JavacPluginName.ProcessorImpl, JAXBIndexProcessor, ManifestProcessor, MatcherGroupProcessor, MustImplement.ProcessorImpl, PatternRegexProcessor, ServiceProviderForProcessor, TargetMustBe.ProcessorImpl, TargetMustExtend.ProcessorImpl, TargetMustHaveConstructor.ProcessorImpl, TargetMustHaveModifiers.ProcessorImpl, TargetMustNotHaveModifiers.ProcessorImpl, WithModifiers.ProcessorImpl, WithoutModifiers.ProcessorImpl

public abstract class AnnotatedProcessor
extends AbstractProcessor

Abstract Processor base class for processing Annotations specified by @For. Provides built-in support for a number of Annotation types.

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

Author:

Allen D. Ball

See Also:

AnnotationValueMustConvertTo, TargetMustBe, TargetMustExtend, TargetMustHaveConstructor, TargetMustHaveModifiers, TargetMustNotHaveModifiers

Nested Class Summary

Nested classes/interfaces inherited from class ball.annotation.processing.AbstractProcessor

AbstractProcessor.Check<T extends Element>, AbstractProcessor.Criterion<T extends Element>

Field Summary

Fields inherited from class ball.annotation.processing.AbstractProcessor

filer, javac

Fields inherited from class ball.annotation.processing.JavaxLangModelUtilities

elements, fm, types

Constructor Summary

Constructors

Constructor	Description
AnnotatedProcessor()

Method Summary

Modifier and Type	Method	Description
protected List<Class<? extends Annotation>>	getSupportedAnnotationTypeList()	Method to get the List of supported Annotation Classes.
Set<String>	getSupportedAnnotationTypes()
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected void	process(RoundEnvironment roundEnv, TypeElement annotation, Element element)	Callback method to process an annotated Element.

Methods inherited from class ball.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, getSupportedSourceVersion, print, print, print, print, print, whenAnnotationProcessingFinished

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, getPropertyName, getPropertyNames, getTypeElementFor, hasSameSignatureAs, hasSameSignatureAs, hasSameSignatureAs, implementationOf, isAssignableTo, isAssignableTo, isAssignableTo, isAssignableTo, isEmptyArray, isGenerated, 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, declaration, declaration, exceptions, getModifiers, getModifiers, modifiers, parameters, type, type

Constructor Detail

AnnotatedProcessor

public AnnotatedProcessor()

Method Detail

getSupportedAnnotationTypeList

protected List<Class<? extends Annotation>> getSupportedAnnotationTypeList()

Method to get the List of supported Annotation Classes.

Returns:

The List of supported Annotation Classes.

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Specified by:

getSupportedAnnotationTypes in class AbstractProcessor

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

process

protected void process(RoundEnvironment roundEnv,
                       TypeElement annotation,
                       Element element)

Callback method to process an annotated Element. Default implementation does nothing.

Parameters:

roundEnv - The RoundEnvironment.

annotation - The annotation TypeElement.

element - The annotated Element.