org.mule.runtime.module.extension.internal.resources

Class BaseExtensionResourcesGeneratorAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.mule.runtime.module.extension.internal.resources.BaseExtensionResourcesGeneratorAnnotationProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

ClassExtensionResourcesGeneratorAnnotationProcessor

@SupportedAnnotationTypes(value="org.mule.runtime.extension.api.annotation.Extension")
 @SupportedSourceVersion(value=RELEASE_8)
 @SupportedOptions(value="extension.version")
public abstract class BaseExtensionResourcesGeneratorAnnotationProcessor
extends AbstractProcessor

Annotation processor that picks up all the extensions annotated with Extension or Extension and uses a ResourcesGenerator to generate the required resources.

This annotation processor will automatically generate and package into the output jar the XSD schema, spring bundles and extension registration files necessary for mule to work with this extension.

Depending on the model properties declared by each extension, some of those resources might or might not be generated

Since:

3.7.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPILATION_MODE
static String	EXTENSION_ELEMENT
static String	EXTENSION_TYPE
static String	EXTENSION_VERSION
static String	PROBLEMS_HANDLER
static String	PROCESSING_ENVIRONMENT
static String	ROUND_ENVIRONMENT

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
BaseExtensionResourcesGeneratorAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	configureLoadingRequest(org.mule.runtime.extension.api.loader.ExtensionModelLoadingRequest.Builder requestBuilder) Override this method for the chance of adding custom parameterization into the requestBuilder.
protected org.mule.runtime.extension.api.loader.ExtensionModelLoader	fetchJavaExtensionModelLoader()
protected abstract org.mule.runtime.extension.api.loader.ExtensionModelLoader	getExtensionModelLoader()
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected abstract boolean	shouldProcess(TypeElement extensionElement, ProcessingEnvironment processingEnv)
abstract ExtensionElement	toExtensionElement(TypeElement typeElement, ProcessingEnvironment processingEnvironment)

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

Field Detail

PROCESSING_ENVIRONMENT

public static final String PROCESSING_ENVIRONMENT

See Also:

Constant Field Values

EXTENSION_ELEMENT

public static final String EXTENSION_ELEMENT

See Also:

Constant Field Values

ROUND_ENVIRONMENT

public static final String ROUND_ENVIRONMENT

See Also:

Constant Field Values

PROBLEMS_HANDLER

public static final String PROBLEMS_HANDLER

See Also:

Constant Field Values

EXTENSION_VERSION

public static final String EXTENSION_VERSION

See Also:

Constant Field Values

EXTENSION_TYPE

public static final String EXTENSION_TYPE

See Also:

Constant Field Values

COMPILATION_MODE

public static final String COMPILATION_MODE

See Also:

Constant Field Values

Constructor Detail

BaseExtensionResourcesGeneratorAnnotationProcessor

public BaseExtensionResourcesGeneratorAnnotationProcessor()

Method Detail

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

fetchJavaExtensionModelLoader

protected org.mule.runtime.extension.api.loader.ExtensionModelLoader fetchJavaExtensionModelLoader()

Returns:

the ExtensionModelLoader for loading Java based Extensions

toExtensionElement

public abstract ExtensionElement toExtensionElement(TypeElement typeElement,
                                                    ProcessingEnvironment processingEnvironment)

getExtensionModelLoader

protected abstract org.mule.runtime.extension.api.loader.ExtensionModelLoader getExtensionModelLoader()

configureLoadingRequest

protected void configureLoadingRequest(org.mule.runtime.extension.api.loader.ExtensionModelLoadingRequest.Builder requestBuilder)

Override this method for the chance of adding custom parameterization into the requestBuilder.

The same builder will later be used to create the ExtensionModelLoadingRequest used in the ExtensionModelLoader.loadExtensionModel(ExtensionModelLoadingRequest) invocation.

This default implementation is no-op

Parameters:

requestBuilder - a ExtensionModelLoadingRequest.Builder

Since:

4.5.0

shouldProcess

protected abstract boolean shouldProcess(TypeElement extensionElement,
                                         ProcessingEnvironment processingEnv)

Returns:

a boolean indicating if the annotation processor is able to process or not with the current context.