org.corfudb.annotations

Class ObjectAnnotationProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.corfudb.annotations.ObjectAnnotationProcessor

All Implemented Interfaces:

Processor

@SupportedAnnotationTypes(value="org.corfudb.annotations.*")
public class ObjectAnnotationProcessor
extends AbstractProcessor

The annotation processor, which takes annotated Corfu objects and generates a class which can be used by the runtime instead of requiring runtime instrumentation.

See README.md for details on how the annotation processor works and how to use it.

Created by mwei on 11/9/16.

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
ObjectAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
void	addConflictFieldFromFunctionToMethod(com.squareup.javapoet.MethodSpec.Builder ms, String conflictField, String functionName, ExecutableElement smrMethod) Add a conflict field to the method.
void	addConflictFieldToMethod(com.squareup.javapoet.MethodSpec.Builder ms, String conflictField, ExecutableElement smrMethod) Add a conflict field to the method.
void	generateProxy(TypeElement classElement) Generate a proxy file.
String	getSmrFunctionName(ExecutableElement smrMethod) Return a SMR function name, extracting it from the annotations if available.
SourceVersion	getSupportedSourceVersion() Always support the latest source version.
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
void	processClass(TypeElement classElement) Process each class, checking if the class is annotated and generating the appropriate proxy class.

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectAnnotationProcessor

public ObjectAnnotationProcessor()

Method Detail

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Always support the latest source version.

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

Returns:

The source version supported.

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

processClass

public void processClass(TypeElement classElement)

Process each class, checking if the class is annotated and generating the appropriate proxy class.

Parameters:

classElement - The element to process.

getSmrFunctionName

public String getSmrFunctionName(ExecutableElement smrMethod)

Return a SMR function name, extracting it from the annotations if available.

Parameters:

smrMethod - The ExecutableElement to extract the name from.

Returns:

An SMR Function name string.

generateProxy

public void generateProxy(TypeElement classElement)
                   throws IOException

Generate a proxy file.

Parameters:

classElement - The element to generate a proxy file for

Throws:

IOException - If we could not generate the proxy file

addConflictFieldToMethod

public void addConflictFieldToMethod(com.squareup.javapoet.MethodSpec.Builder ms,
                                     String conflictField,
                                     ExecutableElement smrMethod)

Add a conflict field to the method.

Parameters:

ms - The builder to add the field to.

conflictField - The name of the field to add

smrMethod - The method element.

addConflictFieldFromFunctionToMethod

public void addConflictFieldFromFunctionToMethod(com.squareup.javapoet.MethodSpec.Builder ms,
                                                 String conflictField,
                                                 String functionName,
                                                 ExecutableElement smrMethod)

Add a conflict field to the method.

Parameters:

ms - The builder to add the field to.

conflictField - The name of the field to add

functionName - The function to call to obtain the parameters.

smrMethod - The method element.