org.adroitlogic.x.annotation

Class AbstractSingularAnnotationProcessor<A extends Annotation,E extends Element>

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.adroitlogic.x.annotation.AbstractSingularAnnotationProcessor<A,E>

All Implemented Interfaces:

Processor

Direct Known Subclasses:

AutoInitializeAnnotationProcessor, AutoStartAnnotationProcessor, BeanRefAnnotationProcessor, ConnectorOperationAnnotationProcessor, EgressConnectorAnnotationProcessor, IngressConnectorAnnotationProcessor, IntegrationFlowValidatorAnnotationProcessor, OutPortAnnotationProcessor, ParameterAnnotationProcessor, ProcessorAnnotationProcessor, XMetricsReporterAnnotationProcessor, XMetricsStreamAnnotationProcessor

public abstract class AbstractSingularAnnotationProcessor<A extends Annotation,E extends Element>
extends AbstractProcessor

The base class for the singular annotation processors, which does the annotation validation at the compilation time

Since:

17.01

Author:

Udith Gunaratna, Ruwan Linton

Field Summary

Fields

Modifier and Type	Field and Description
protected Elements	elementUtils
protected Types	typeUtils

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AbstractSingularAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
Set<String>	getSupportedAnnotationTypes()
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
protected boolean	isImplementedByInterface(TypeElement element, String interfaceName) This method recursively checks whether a given interface is implemented by a given type element or by at least one of the interfaces of its hierarchy
protected boolean	isImplementedBySuper(TypeElement element, String interfaceName) This method checks whether a given interface is implemented by at least one of the super classes of given type element
protected boolean	isInterfaceImplemented(TypeElement element, String interfaceName) This method combines isImplementedByInterface(TypeElement, String) and isImplementedBySuper(TypeElement, String) methods
protected boolean	isOfElementKinds(EnumSet<ElementKind> elementKinds, Element element) This method checks whether the given element belongs to one of the given element kinds
protected void	printError(String msg, Element e, Object... args) This method writes an error kind message to the provided Messager
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected abstract void	processRules(SingularAnnotationProcessingContext<A,E> sapc)
protected abstract boolean	validateElementKind(Element element)

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

typeUtils

protected Types typeUtils

elementUtils

protected Elements elementUtils

Constructor Detail

AbstractSingularAnnotationProcessor

public AbstractSingularAnnotationProcessor()

Method Detail

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class AbstractProcessor

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

validateElementKind

protected abstract boolean validateElementKind(Element element)

processRules

protected abstract void processRules(SingularAnnotationProcessingContext<A,E> sapc)

isOfElementKinds

protected boolean isOfElementKinds(EnumSet<ElementKind> elementKinds,
                                   Element element)

This method checks whether the given element belongs to one of the given element kinds

Parameters:

elementKinds - Set of ElementKind to check against

element - Element to be validated

Returns:

true if the given element belongs to one of the given element kinds, false otherwise

printError

protected void printError(String msg,
                          Element e,
                          Object... args)

This method writes an error kind message to the provided Messager

Parameters:

msg - Error message content

e - Element related to the error message

args - list of arguments for the message content

isImplementedByInterface

protected boolean isImplementedByInterface(TypeElement element,
                                           String interfaceName)

This method recursively checks whether a given interface is implemented by a given type element or by at least one of the interfaces of its hierarchy

Parameters:

element - type element to be checked

interfaceName - name of the interface to be checked against

Returns:

true if implemented, false otherwise

isInterfaceImplemented

protected boolean isInterfaceImplemented(TypeElement element,
                                         String interfaceName)

This method combines isImplementedByInterface(TypeElement, String) and isImplementedBySuper(TypeElement, String) methods

Parameters:

element - type element to be checked

interfaceName - name of the interface to be checked against

Returns:

true if implemented, false otherwise

isImplementedBySuper

protected boolean isImplementedBySuper(TypeElement element,
                                       String interfaceName)

This method checks whether a given interface is implemented by at least one of the super classes of given type element

Parameters:

element - type element to be checked

interfaceName - name of the interface to be checked against

Returns:

true if implemented, false otherwise