org.eclipse.xtend.lib.macro

Class AbstractFieldProcessor

java.lang.Object

org.eclipse.xtend.lib.macro.AbstractFieldProcessor

All Implemented Interfaces:

CodeGenerationParticipant<FieldDeclaration>, RegisterGlobalsParticipant<FieldDeclaration>, TransformationParticipant<MutableFieldDeclaration>, ValidationParticipant<FieldDeclaration>

@Beta
public abstract class AbstractFieldProcessor
extends java.lang.Object
implements RegisterGlobalsParticipant<FieldDeclaration>, TransformationParticipant<MutableFieldDeclaration>, CodeGenerationParticipant<FieldDeclaration>, ValidationParticipant<FieldDeclaration>

A convenient base class to process active annotations for fields.

Constructor Summary

Constructors

Constructor and Description
AbstractFieldProcessor()

Method Summary

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

AbstractFieldProcessor

public AbstractFieldProcessor()

Method Detail

doRegisterGlobals

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

Description copied from interface: RegisterGlobalsParticipant

Called by the compiler during register-globals phase.

Specified by:

doRegisterGlobals in interface RegisterGlobalsParticipant<FieldDeclaration>

Parameters:

annotatedFields - 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(FieldDeclaration annotatedField,
                              @Extension
                              RegisterGlobalsContext context)

Parameters:

annotatedField - a source field annotated with the annotation this processor is responsible for.

context -

doTransform

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

Description copied from interface: TransformationParticipant

Invoked by the compiler

Specified by:

doTransform in interface TransformationParticipant<MutableFieldDeclaration>

Parameters:

annotatedfields - the mutable java representation of the annotated elements

context - a TransformationContext providing useful services.

doTransform

public void doTransform(MutableFieldDeclaration annotatedField,
                        @Extension
                        TransformationContext context)

Parameters:

annotatedField - a mutable field representation annotated with the annotation this processor is responsible for.

context -

doGenerateCode

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

Description copied from interface: CodeGenerationParticipant

Invoked by the compiler during the code generation phase.

Specified by:

doGenerateCode in interface CodeGenerationParticipant<FieldDeclaration>

Parameters:

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

context - a TransformationContext providing useful services.

doGenerateCode

public void doGenerateCode(FieldDeclaration annotatedField,
                           @Extension
                           CodeGenerationContext context)

Called during code generation.

Parameters:

annotatedField - 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 FieldDeclaration> annotatedFields,
                       @Extension
                       ValidationContext context)

Description copied from interface: ValidationParticipant

Invoked by the validator

Specified by:

doValidate in interface ValidationParticipant<FieldDeclaration>

Parameters:

annotatedFields - the java representation of the annotated elements

context - a ValidationContext providing useful services.

doValidate

public void doValidate(FieldDeclaration annotatedField,
                       @Extension
                       ValidationContext context)

Invoked by the validator

Parameters:

annotatedField - the generated field that should be validated

context -

Since:

2.7

See Also:

doValidate(List, ValidationContext)