com.github.misberner.apcommons.processing

Interface SingleAnnotationProcessorModule<A extends Annotation>

All Known Implementing Classes:

AbstractSingleAnnotationProcessor, CheckEnclosingAnnotatedProcessor

public interface SingleAnnotationProcessorModule<A extends Annotation>

A processor module for isolated, per-element processing of a single annotation type.

Author:

Malte Isberner

Method Summary

Methods

Modifier and Type	Method and Description
Class<A>	getAnnotationType() Retrieves the annotation type associated with this module.
void	post(APUtils utils) Called after the successful processing of all elements.
void	postFailure(APUtils utils) Called after unsuccessful processing of all elements, or if processing was aborted due to a fatal processing error.
void	pre(APUtils utils) Called before the first element is processed.
void	process(Element elem, AnnotationMirror annotationMirror, A annotation, APUtils utils) Process a single annotated element.

Method Detail

getAnnotationType

Class<A> getAnnotationType()

Retrieves the annotation type associated with this module.

Returns:

the annotation type

pre

void pre(APUtils utils)
         throws Exception,
                ProcessingException

Called before the first element is processed. If this method throws an exception, no element processing will happen.

Parameters:

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs

process

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

Process a single annotated element.

Parameters:

elem - the element to process

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

annotation - 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

post

void post(APUtils utils)
          throws Exception,
                 ProcessingException

Called after the successful processing of all elements.

Parameters:

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs

postFailure

void postFailure(APUtils utils)
                 throws Exception,
                        ProcessingException

Called after unsuccessful processing of all elements, or if processing was aborted due to a fatal processing error.

Parameters:

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs