org.uberfire.annotations.processors

Class AbstractErrorAbsorbingProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

org.uberfire.annotations.processors.AbstractErrorAbsorbingProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

PerspectiveProcessor, WorkbenchContextProcessor, WorkbenchEditorProcessor, WorkbenchPopupProcessor, WorkbenchScreenProcessor, WorkbenchSplashScreenProcessor

public abstract class AbstractErrorAbsorbingProcessor
extends AbstractProcessor

Contains a series of adaptations and workarounds to make annotation processors work well under Eclipse JDT APT. Does not limit compatibility with other annotation processing environments (such as javac).

Field Summary

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractErrorAbsorbingProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	init(ProcessingEnvironment env) Wraps the given processing environment with one that protects against known bugs in the Eclipse annotation processing implementation.
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected abstract boolean	processWithExceptions(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Same contract as process(Set, RoundEnvironment), except that any exceptions thrown are caught and printed as messages of type Diagnostic.Kind.ERROR.
protected void	rememberInitializationError(Throwable t) Subclasses must call this from their constructors if something throws an exception during initialization of the instance.
protected void	writeCode(String packageName, String className, StringBuffer code) Writes the given code to javac's Filer.

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractErrorAbsorbingProcessor

protected AbstractErrorAbsorbingProcessor()

Method Detail

init

public void init(ProcessingEnvironment env)

Wraps the given processing environment with one that protects against known bugs in the Eclipse annotation processing implementation.

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

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

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

rememberInitializationError

protected void rememberInitializationError(Throwable t)

Subclasses must call this from their constructors if something throws an exception during initialization of the instance. Once this method has been called with a non-null throwable, the processWithExceptions(Set, RoundEnvironment) method will not be called on this instance.

Parameters:

t - the exception that occurred (and was caught) during instance creation of this annotation processor instance.

processWithExceptions

protected abstract boolean processWithExceptions(Set<? extends TypeElement> annotations,
                            RoundEnvironment roundEnv)
                                          throws Exception

Same contract as process(Set, RoundEnvironment), except that any exceptions thrown are caught and printed as messages of type Diagnostic.Kind.ERROR. This is done to keep Eclipse JDT from going into an infinite processing loop.

Throws:

Exception

writeCode

protected final void writeCode(String packageName,
             String className,
             StringBuffer code)
                        throws IOException

Writes the given code to javac's Filer.

Throws:

IOException