com.github.misberner.apcommons.processing

Class CheckEnclosingAnnotatedProcessor<A extends Annotation>

java.lang.Object

com.github.misberner.apcommons.processing.AbstractSingleAnnotationProcessor<A>

com.github.misberner.apcommons.processing.CheckEnclosingAnnotatedProcessor<A>

Type Parameters:

A - annotation type

All Implemented Interfaces:

SingleAnnotationProcessorModule<A>

public class CheckEnclosingAnnotatedProcessor<A extends Annotation>
extends AbstractSingleAnnotationProcessor<A>

Checks whether the enclosing element of an annotated element is also annotated with a certain annotation.

This is useful in cases where annotations supply only additional informations, but the annotated elements should not be processed as root elements (e.g., method parameters in annotated methods). Usually a warning or error should be issued if such annotations are found without the enclosing element being annotated.

Author:

Malte Isberner

Constructor Summary

Constructors

Constructor and Description
CheckEnclosingAnnotatedProcessor(Class<A> annotationType, boolean onlyDirect, Diagnostic.Kind diagnosticKind, Class<? extends Annotation>... expectedAnnotations) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	process(Element elem, AnnotationMirror annotation, A annotationObject, APUtils utils) Process a single annotated element.

Methods inherited from class com.github.misberner.apcommons.processing.AbstractSingleAnnotationProcessor

getAnnotationType, post, postFailure, pre

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckEnclosingAnnotatedProcessor

@SafeVarargs
public CheckEnclosingAnnotatedProcessor(Class<A> annotationType,
                                            boolean onlyDirect,
                                            Diagnostic.Kind diagnosticKind,
                                            Class<? extends Annotation>... expectedAnnotations)

Constructor.

Parameters:

annotationType - the annotation type to check

onlyDirect - whether or not to consider only the directly enclosing element, or all ancestors

diagnosticKind - the diagnostic kind to use if the enclosing element is not annotated with one of the expected annotations.

expectedAnnotations - the expected annotations of the enclosing elements

Method Detail

process

public void process(Element elem,
           AnnotationMirror annotation,
           A annotationObject,
           APUtils utils)
             throws Exception,
                    ProcessingException

Description copied from interface: SingleAnnotationProcessorModule

Process a single annotated element.

Specified by:

process in interface SingleAnnotationProcessorModule<A extends Annotation>

Overrides:

process in class AbstractSingleAnnotationProcessor<A extends Annotation>

Parameters:

elem - the element to process

annotation - the annotation mirror corresponding to the annotation to process.

annotationObject - the annotation object corresponding to the annotation to process.

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs