Package org.eclipse.xtend.lib.macro

Class AbstractMethodProcessor

java.lang.Object

org.eclipse.xtend.lib.macro.AbstractMethodProcessor

All Implemented Interfaces:

CodeGenerationParticipant<MethodDeclaration>, RegisterGlobalsParticipant<MethodDeclaration>, TransformationParticipant<MutableMethodDeclaration>, ValidationParticipant<MethodDeclaration>

@Beta
public abstract class AbstractMethodProcessor
extends java.lang.Object
implements RegisterGlobalsParticipant<MethodDeclaration>, TransformationParticipant<MutableMethodDeclaration>, CodeGenerationParticipant<MethodDeclaration>, ValidationParticipant<MethodDeclaration>

A convenient base class to process active annotations for methods.

Constructor Summary

Constructors

Constructor	Description
AbstractMethodProcessor()

Method Summary

Modifier and Type	Method	Description
void	doGenerateCode(java.util.List<? extends MethodDeclaration> annotatedMethods, CodeGenerationContext context)	Invoked by the compiler during the code generation phase.
void	doGenerateCode(MethodDeclaration annotatedMethod, CodeGenerationContext context)
void	doRegisterGlobals(java.util.List<? extends MethodDeclaration> annotatedMethods, RegisterGlobalsContext context)	Called by the compiler during register-globals phase.
void	doRegisterGlobals(MethodDeclaration annotatedMethod, RegisterGlobalsContext context)
void	doTransform(java.util.List<? extends MutableMethodDeclaration> annotatedMethods, TransformationContext context)	Invoked by the compiler
void	doTransform(MutableMethodDeclaration annotatedMethod, TransformationContext context)
void	doValidate(java.util.List<? extends MethodDeclaration> annotatedMethods, ValidationContext context)	Invoked by the validator
void	doValidate(MethodDeclaration annotatedMethod, 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

AbstractMethodProcessor

public AbstractMethodProcessor()

Method Detail

doRegisterGlobals

public void doRegisterGlobals(java.util.List<? extends MethodDeclaration> annotatedMethods,
                              RegisterGlobalsContext context)

Description copied from interface: RegisterGlobalsParticipant

Called by the compiler during register-globals phase.

Specified by:

doRegisterGlobals in interface RegisterGlobalsParticipant<MethodDeclaration>

Parameters:

annotatedMethods - 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(MethodDeclaration annotatedMethod,
                              RegisterGlobalsContext context)

Parameters:

annotatedMethod - a source method annotated with the annotation this processor is responsible for.

context -

doTransform

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

Description copied from interface: TransformationParticipant

Invoked by the compiler

Specified by:

doTransform in interface TransformationParticipant<MutableMethodDeclaration>

Parameters:

annotatedMethods - the mutable java representation of the annotated elements

context - a TransformationContext providing useful services.

doTransform

public void doTransform(MutableMethodDeclaration annotatedMethod,
                        @Extension
                        TransformationContext context)

Parameters:

annotatedMethod - a mutable method representation annotated with the annotation this processor is responsible for.

context -

doGenerateCode

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

Description copied from interface: CodeGenerationParticipant

Invoked by the compiler during the code generation phase.

Specified by:

doGenerateCode in interface CodeGenerationParticipant<MethodDeclaration>

Parameters:

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

context - a TransformationContext providing useful services.

doGenerateCode

public void doGenerateCode(MethodDeclaration annotatedMethod,
                           @Extension
                           CodeGenerationContext context)

Parameters:

annotatedMethod - a source method annotated with the annotation this processor is responsible for.

context -

doValidate

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

Description copied from interface: ValidationParticipant

Invoked by the validator

Specified by:

doValidate in interface ValidationParticipant<MethodDeclaration>

Parameters:

annotatedMethods - the java representation of the annotated elements

context - a ValidationContext providing useful services.

doValidate

public void doValidate(MethodDeclaration annotatedMethod,
                       ValidationContext context)

Invoked by the validator

Parameters:

annotatedMethod - that generated method that should be validated

context -

Since:

2.7

See Also:

doValidate(MethodDeclaration, ValidationContext)