Module xaos.tools

Package eu.ess.xaos.tools.lang

Class AbstractAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

eu.ess.xaos.tools.lang.AbstractAnnotationProcessor

All Implemented Interfaces:

Processor

public abstract class AbstractAnnotationProcessor
extends AbstractProcessor

An AbstractProcessor with some common utilities.

Author:

claudiorosati

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
AbstractAnnotationProcessor()

Method Summary

Modifier and Type	Method	Description
protected String	binaryName(TypeElement element)
protected AnnotationMirror	findAnnotationMirror(Element element, Class<? extends Annotation> annotation)	Returns the mirror for the given annotation.
protected AnnotationValue	findAnnotationValue(AnnotationMirror annotation, String name)	Returns the value for the given annotation.
protected Elements	getElements()
protected ProcessingEnvironment	getEnvironment()	A clean way of accessing AbstractProcessor.processingEnv.
protected Filer	getFiler()
protected Messager	getMessager()
protected Types	getTypes()

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, init, isInitialized, process

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAnnotationProcessor

public AbstractAnnotationProcessor()

Method Detail

binaryName

protected String binaryName(TypeElement element)

Parameters:

element - The TypeElement whose binary name must be returned.

Returns:

The binary name of the given element.

findAnnotationMirror

protected AnnotationMirror findAnnotationMirror(Element element,
                                                Class<? extends Annotation> annotation)

Returns the mirror for the given annotation.

Parameters:

element - A source element.

annotation - A type of annotation.

Returns:

The instance of that annotation on the element, or null if not found.

findAnnotationValue

protected AnnotationValue findAnnotationValue(AnnotationMirror annotation,
                                              String name)

Returns the value for the given annotation.

Parameters:

annotation - An annotation instance (null permitted).

name - The name of an attribute of that annotation.

Returns:

The corresponding annotation value if found.

getElements

protected Elements getElements()

Returns:

ProcessingEnvironment.getElementUtils().

getEnvironment

protected ProcessingEnvironment getEnvironment()

A clean way of accessing AbstractProcessor.processingEnv.

Returns:

AbstractProcessor.processingEnv.

getFiler

protected Filer getFiler()

Returns:

ProcessingEnvironment.getFiler().

getMessager

protected Messager getMessager()

Returns:

The Messager used to report errors, warnings, and other notices.

getTypes

protected Types getTypes()

Returns:

ProcessingEnvironment.getTypeUtils().