com.gwtplatform.dispatch.annotation.processor

Class GenProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

com.gwtplatform.dispatch.annotation.processor.GenProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

GenDispatchProcessor, GenDtoProcessor, GenEventProcessor, GenProxyProcessor

public abstract class GenProcessor
extends AbstractProcessor

Abstract processor class for all @GenX annotations.

Annotate your processor with @SupportedAnnotationTypes or override AbstractProcessor.getSupportedAnnotationTypes() to receive elements, that are annotated in the current environment with one of the given annotations. You can get access these elements using the method process(Element annotatedElement).

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
GenProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
ProcessingEnvironment	getEnvironment() Returns the current processing environment.
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment environment)
void	onProcessingCompleted() Utility method called after the processing is finished.
void	onProcessingStarted() Utility method called after processing has started.
void	printError(String message) Prints an error.
void	printMessage(String message) Prints a message.
abstract void	process(Element annotatedElement) Override this function to receive elements which you've declared in supported annotations.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnvironment)

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

GenProcessor

public GenProcessor()

Method Detail

init

public void init(ProcessingEnvironment environment)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

getEnvironment

public ProcessingEnvironment getEnvironment()

Returns the current processing environment.

Returns:

the processing environment.

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

printMessage

public void printMessage(String message)

Prints a message.

Parameters:

message - the message

printError

public void printError(String message)

Prints an error.

Parameters:

message - the error message

process

public abstract void process(Element annotatedElement)

Override this function to receive elements which you've declared in supported annotations.

Parameters:

annotatedElement - the annotated element.

onProcessingStarted

public void onProcessingStarted()

Utility method called after processing has started.

onProcessingCompleted

public void onProcessingCompleted()

Utility method called after the processing is finished.