cz.ues.platform.apt

Class AbstractAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

cz.ues.platform.apt.AbstractAnnotationProcessor

All Implemented Interfaces:

javax.annotation.processing.Processor

@SupportedSourceVersion(value=RELEASE_6)
public abstract class AbstractAnnotationProcessor
extends javax.annotation.processing.AbstractProcessor

UES generic annotations-processor,should be extended by specialized tools in components.

Since:

UES6-00

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractAnnotationProcessor.FileType

Field Summary

Fields

Modifier and Type	Field and Description
private ProcessingContext	ctx
private static java.lang.String	MSG_GENERATING_FILE Message (File generated).

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
AbstractAnnotationProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
private void	generateFile(AbstractAnnotationProcessor.FileType ftype, TypeModel model, java.lang.String templateName, java.lang.String targetFolder, java.lang.String outputFilePathname)
protected void	generateFile(TypeModel model, java.lang.String templateName, java.lang.String targetFolder, java.lang.String outputFilePathname)
private void	generateMultiModelFile(AbstractAnnotationProcessor.FileType ftype, java.util.Collection<? extends TypeModel> model, java.lang.String templateName, java.lang.String targetFolder, java.lang.String outputFilePathname)
protected void	generateMultiModelFile(java.util.Collection<? extends TypeModel> model, java.lang.String templateName, java.lang.String targetFolder, java.lang.String outputFilePathname)
protected void	generateMultiModelResourceFile(java.util.Collection<? extends TypeModel> model, java.lang.String templateName, java.lang.String outputFilePathname)
protected void	generateResourceFile(TypeModel model, java.lang.String templateName, java.lang.String outputFilePathname) Generates the resource file to "-s" directory with specified filename path.
protected void	generateSourceFile(TypeModel model, java.lang.String templateName) Generates the source file to "-s" directory with filename derived from TypeModel.getQualifiedName().
protected ProcessingContext	getProcessingContext()
protected abstract java.lang.Class<? extends java.lang.annotation.Annotation>[]	getSupportedAnnotations() The same purpose as AbstractAnnotationProcessor.getSupportedAnnotationTypes(), but this method supports strong type validation (by compiler) of supported Annotation.
java.util.Set<java.lang.String>	getSupportedAnnotationTypes()
void	init(javax.annotation.processing.ProcessingEnvironment processingEnv)
protected abstract boolean	process()
boolean	process(java.util.Set<? extends javax.lang.model.element.TypeElement> aAnnotations, javax.annotation.processing.RoundEnvironment roundEnv)
private void	replaceTargetFolder(javax.tools.FileObject fileObject, java.lang.String targetFolder) Replaces existing target folder in file object from "generated/java" to "generated/${targetFolder}".

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedOptions, getSupportedSourceVersion, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

MSG_GENERATING_FILE

private static final MSG_GENERATING_FILE

Message (File generated).

See Also:

Constant Field Values

ctx

private ctx

Constructor Detail

AbstractAnnotationProcessor

public AbstractAnnotationProcessor()

Method Detail

init

public void init(javax.annotation.processing.ProcessingEnvironment processingEnv)

Specified by:

init in interface javax.annotation.processing.Processor

Overrides:

init in class javax.annotation.processing.AbstractProcessor

Since:

UES6-00

See Also:

AbstractProcessor.init(javax.annotation.processing.ProcessingEnvironment)

getSupportedAnnotationTypes

public java.util.Set<java.lang.String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface javax.annotation.processing.Processor

Overrides:

getSupportedAnnotationTypes in class javax.annotation.processing.AbstractProcessor

Since:

UES6-00

See Also:

AbstractProcessor.getSupportedAnnotationTypes()

getSupportedAnnotations

protected abstract java.lang.Class<? extends java.lang.annotation.Annotation>[] getSupportedAnnotations()

The same purpose as AbstractAnnotationProcessor.getSupportedAnnotationTypes(), but this method supports strong type validation (by compiler) of supported Annotation. We recommend to use this method instead of @SupportedAnnotationTypes annotation on processor.

Returns:

Array of supported Annotations or NULL to obtain the set of annotations types by standard way from @ SupportedAnnotationTypes.

Since:

UES6-00

process

public boolean process(java.util.Set<? extends javax.lang.model.element.TypeElement> aAnnotations,
javax.annotation.processing.RoundEnvironment roundEnv)

Specified by:

process in interface javax.annotation.processing.Processor

Specified by:

process in class javax.annotation.processing.AbstractProcessor

Since:

UES6-00

See Also:

AbstractProcessor.process(java.util.Set, javax.annotation.processing.RoundEnvironment)

process

protected abstract boolean process()

generateSourceFile

protected void generateSourceFile(TypeModel model,
java.lang.String templateName)

Generates the source file to "-s" directory with filename derived from TypeModel.getQualifiedName().

Parameters:

model - The model to be generated by template to source-file.

templateName - The template to be used for output body of the source file.

Since:

UES6-00

generateResourceFile

protected void generateResourceFile(TypeModel model,
java.lang.String templateName,
java.lang.String outputFilePathname)

Generates the resource file to "-s" directory with specified filename path.

Parameters:

model - The model to be generated by template to resource-file.

templateName - The template to be used for output body of the resource file.

outputFilePathname - The full path name added to source-dir.For example "resources/myresource.xml"

Since:

UES6-00

generateFile

protected void generateFile(TypeModel model,
java.lang.String templateName,
java.lang.String targetFolder,
java.lang.String outputFilePathname)

generateMultiModelResourceFile

protected void generateMultiModelResourceFile(java.util.Collection<? extends TypeModel> model,
java.lang.String templateName,
java.lang.String outputFilePathname)

generateMultiModelFile

protected void generateMultiModelFile(java.util.Collection<? extends TypeModel> model,
java.lang.String templateName,
java.lang.String targetFolder,
java.lang.String outputFilePathname)

generateFile

private void generateFile(AbstractAnnotationProcessor.FileType ftype,
TypeModel model,
java.lang.String templateName,
java.lang.String targetFolder,
java.lang.String outputFilePathname)

generateMultiModelFile

private void generateMultiModelFile(AbstractAnnotationProcessor.FileType ftype,
java.util.Collection<? extends TypeModel> model,
java.lang.String templateName,
java.lang.String targetFolder,
java.lang.String outputFilePathname)

replaceTargetFolder

private void replaceTargetFolder(javax.tools.FileObject fileObject,
java.lang.String targetFolder)

Replaces existing target folder in file object from "generated/java" to "generated/${targetFolder}". (must be done via reflection because there is no suitable API to create resource file)

Parameters:

fileObject - File object to be replaced

targetFolder - New folder "generated/${targetFolder}" to be used instead of "generated/java"

Since:

UES6-00

getProcessingContext

protected ProcessingContext getProcessingContext()

Returns:

The processing context associated with this processor.

Since:

UES6-00