com.github.misberner.apcommons.processing

Class AbstractSingleAnnotationProcessor<A extends Annotation>

java.lang.Object

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

Type Parameters:

A - annotation type

All Implemented Interfaces:

SingleAnnotationProcessorModule<A>

Direct Known Subclasses:

CheckEnclosingAnnotatedProcessor

public abstract class AbstractSingleAnnotationProcessor<A extends Annotation>
extends Object
implements SingleAnnotationProcessorModule<A>

Abstract base class for SingleAnnotationProcessorModule implementations.

Author:

Malte Isberner

Constructor Summary

Constructors

Constructor and Description
AbstractSingleAnnotationProcessor(Class<A> annotationType) Constructor.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSingleAnnotationProcessor

public AbstractSingleAnnotationProcessor(Class<A> annotationType)

Constructor.

Parameters:

annotationType - the annotation type processed by this module

Method Detail

getAnnotationType

public Class<A> getAnnotationType()

Description copied from interface: SingleAnnotationProcessorModule

Retrieves the annotation type associated with this module.

Specified by:

getAnnotationType in interface SingleAnnotationProcessorModule<A extends Annotation>

Returns:

the annotation type

pre

public void pre(APUtils utils)
         throws Exception,
                ProcessingException

Description copied from interface: SingleAnnotationProcessorModule

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

Specified by:

pre in interface SingleAnnotationProcessorModule<A extends Annotation>

Parameters:

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs

process

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

Description copied from interface: SingleAnnotationProcessorModule

Process a single annotated element.

Specified by:

process in interface SingleAnnotationProcessorModule<A extends Annotation>

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

public void post(APUtils utils)
          throws Exception,
                 ProcessingException

Description copied from interface: SingleAnnotationProcessorModule

Called after the successful processing of all elements.

Specified by:

post in interface SingleAnnotationProcessorModule<A extends Annotation>

Parameters:

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs

postFailure

public void postFailure(APUtils utils)
                 throws Exception,
                        ProcessingException

Description copied from interface: SingleAnnotationProcessorModule

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

Specified by:

postFailure in interface SingleAnnotationProcessorModule<A extends Annotation>

Parameters:

utils - the utility object

Throws:

Exception - if an error occurs

ProcessingException - if a processing-related error occurs