org.eclipse.xtend.lib.macro

Class AbstractAnnotationTypeProcessor

java.lang.Object

org.eclipse.xtend.lib.macro.AbstractAnnotationTypeProcessor

All Implemented Interfaces:

CodeGenerationParticipant<AnnotationTypeDeclaration>, RegisterGlobalsParticipant<AnnotationTypeDeclaration>, TransformationParticipant<MutableAnnotationTypeDeclaration>, ValidationParticipant<AnnotationTypeDeclaration>

@Beta
public abstract class AbstractAnnotationTypeProcessor
extends java.lang.Object
implements RegisterGlobalsParticipant<AnnotationTypeDeclaration>, TransformationParticipant<MutableAnnotationTypeDeclaration>, CodeGenerationParticipant<AnnotationTypeDeclaration>, ValidationParticipant<AnnotationTypeDeclaration>

A convenient base class to process active annotations for annotation types.

Constructor Summary

Constructors

Constructor and Description
AbstractAnnotationTypeProcessor()

Method Summary

Modifier and Type	Method and Description
void	doGenerateCode(AnnotationTypeDeclaration annotatedAnnotationType, CodeGenerationContext context) Called during code generation.
void	doGenerateCode(java.util.List<? extends AnnotationTypeDeclaration> annotatedSourceElements, CodeGenerationContext context) Invoked by the compiler during the code generation phase.
void	doRegisterGlobals(AnnotationTypeDeclaration annotatedAnnotationType, RegisterGlobalsContext context) Called during global symbol collecting.
void	doRegisterGlobals(java.util.List<? extends AnnotationTypeDeclaration> annotatedAnnotationTypes, RegisterGlobalsContext context) Called by the compiler during register-globals phase.
void	doTransform(java.util.List<? extends MutableAnnotationTypeDeclaration> annotatedAnnotationTypes, TransformationContext context) Invoked by the compiler
void	doTransform(MutableAnnotationTypeDeclaration annotatedAnnotationType, TransformationContext context)
void	doValidate(AnnotationTypeDeclaration annotatedAnnotationType, ValidationContext context) Invoked by the validator
void	doValidate(java.util.List<? extends AnnotationTypeDeclaration> annotatedAnnotationTypes, ValidationContext context) Invoked by the validator

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAnnotationTypeProcessor

public AbstractAnnotationTypeProcessor()

Method Detail

doRegisterGlobals

public void doRegisterGlobals(java.util.List<? extends AnnotationTypeDeclaration> annotatedAnnotationTypes,
                              @Extension
                              RegisterGlobalsContext context)

Description copied from interface: RegisterGlobalsParticipant

Called by the compiler during register-globals phase.

Specified by:

doRegisterGlobals in interface RegisterGlobalsParticipant<AnnotationTypeDeclaration>

Parameters:

annotatedAnnotationTypes - the source elements from the currently processed compilation unit which are annotated with active annotation

context - services to register new Java types

See Also:

RegisterGlobalsContext

doRegisterGlobals

public void doRegisterGlobals(AnnotationTypeDeclaration annotatedAnnotationType,
                              @Extension
                              RegisterGlobalsContext context)

Called during global symbol collecting.

Parameters:

annotatedAnnotationType - a source element annotated with the annotation this processor is responsible for.

context -

doTransform

public void doTransform(java.util.List<? extends MutableAnnotationTypeDeclaration> annotatedAnnotationTypes,
                        @Extension
                        TransformationContext context)

Description copied from interface: TransformationParticipant

Invoked by the compiler

Specified by:

doTransform in interface TransformationParticipant<MutableAnnotationTypeDeclaration>

Parameters:

annotatedAnnotationTypes - the mutable java representation of the annotated elements

context - a TransformationContext providing useful services.

doTransform

public void doTransform(MutableAnnotationTypeDeclaration annotatedAnnotationType,
                        @Extension
                        TransformationContext context)

Parameters:

annotatedAnnotationType - a mutable annotation type representation annotated with the annotation this processor is responsible for.

context -

doGenerateCode

public void doGenerateCode(java.util.List<? extends AnnotationTypeDeclaration> annotatedSourceElements,
                           @Extension
                           CodeGenerationContext context)

Description copied from interface: CodeGenerationParticipant

Invoked by the compiler during the code generation phase.

Specified by:

doGenerateCode in interface CodeGenerationParticipant<AnnotationTypeDeclaration>

Parameters:

annotatedSourceElements - the immutable source representation (i.e. the Xtend AST) of the annotated elements

context - a TransformationContext providing useful services.

doGenerateCode

public void doGenerateCode(AnnotationTypeDeclaration annotatedAnnotationType,
                           @Extension
                           CodeGenerationContext context)

Called during code generation.

Parameters:

annotatedAnnotationType - a source element annotated with the annotation this processor is responsible for.

context -

See Also:

CodeGenerationParticipant.doGenerateCode(List, CodeGenerationContext)

doValidate

public void doValidate(java.util.List<? extends AnnotationTypeDeclaration> annotatedAnnotationTypes,
                       @Extension
                       ValidationContext context)

Description copied from interface: ValidationParticipant

Invoked by the validator

Specified by:

doValidate in interface ValidationParticipant<AnnotationTypeDeclaration>

Parameters:

annotatedAnnotationTypes - the java representation of the annotated elements

context - a ValidationContext providing useful services.

doValidate

public void doValidate(AnnotationTypeDeclaration annotatedAnnotationType,
                       @Extension
                       ValidationContext context)

Invoked by the validator

Parameters:

annotatedAnnotationType - the generated annotation type that should be validated

context -

Since:

2.7

See Also:

doValidate(List, ValidationContext)