org.drombler.acp.core.application.processing

Class AbstractApplicationAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.drombler.acp.core.application.processing.AbstractApplicationAnnotationProcessor

All Implemented Interfaces:

Processor

public abstract class AbstractApplicationAnnotationProcessor
extends AbstractProcessor

A base class for annotation processors to register extensions in the application.xml file.

Implementations must add:

• an instance of the JAXB root element: addExtensionConfiguration(java.lang.Object)
• the model elements with the annotations: addOriginatingElements(javax.lang.model.element.Element...)
• either the JAXB root element type: addJAXBRootClass(java.lang.Class) or the package of the JAXB root element type: addJAXBPackage(java.lang.String)

Author:

puce

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AbstractApplicationAnnotationProcessor() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
protected static void	addExtensionConfiguration(Object extensionConfiguration) Adds an extension configuration (an instance of a JAXB root class of the extension point).
protected static void	addJAXBPackage(String jaxbPackageName) Adds the JAXB package of the extension point.
protected static void	addJAXBRootClass(Class<?> jaxbRootClass) Adds the JAXB root class of the extension point.
protected static void	addOriginatingElements(Element... originatingElements) Adds the originating elements.
protected JAXBContext	createJAXBContext() Creates a JAXB context.
protected abstract boolean	handleProcess(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Handles the specific annotations.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Calls handleProcess(java.util.Set, javax.annotation.processing.RoundEnvironment) and then writes the application file, if the processing is over.

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, init, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractApplicationAnnotationProcessor

public AbstractApplicationAnnotationProcessor()

Creates a new instance of this class.

Method Detail

process

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

Calls handleProcess(java.util.Set, javax.annotation.processing.RoundEnvironment) and then writes the application file, if the processing is over.

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

Parameters:

annotations - the annotations

roundEnv - the round environment

Returns:

true, if the set of annotations is claimed, else false

See Also:

RoundEnvironment.processingOver()

handleProcess

protected abstract boolean handleProcess(Set<? extends TypeElement> annotations,
                                         RoundEnvironment roundEnv)

Handles the specific annotations.

Implementations must add:

• addExtensionConfiguration(java.lang.Object)
• addOriginatingElements(javax.lang.model.element.Element...)
• either addJAXBRootClass(java.lang.Class) or addJAXBPackage(java.lang.String)

Parameters:

annotations - the annotations

roundEnv - the round environment

Returns:

true, if the set of annotations is claimed, else false

createJAXBContext

protected JAXBContext createJAXBContext()
                                 throws JAXBException

Creates a JAXB context.

Returns:

a JAXB context

Throws:

JAXBException

addJAXBRootClass

protected static void addJAXBRootClass(Class<?> jaxbRootClass)

Adds the JAXB root class of the extension point.

Parameters:

jaxbRootClass - the JAXB root class of the extension point

See Also:

ExtensionPoint.getJAXBRootClass()

addJAXBPackage

protected static void addJAXBPackage(String jaxbPackageName)

Adds the JAXB package of the extension point.

Parameters:

jaxbPackageName - the JAXB package name of the extension point

See Also:

ExtensionPoint.getJAXBRootClass()

addExtensionConfiguration

protected static void addExtensionConfiguration(Object extensionConfiguration)

Adds an extension configuration (an instance of a JAXB root class of the extension point).

Parameters:

extensionConfiguration - an extension configuration to add

See Also:

addJAXBRootClass(java.lang.Class)

addOriginatingElements

protected static void addOriginatingElements(Element... originatingElements)

Adds the originating elements.

Parameters:

originatingElements - the originating elements