org.eclipse.xtend.lib.macro

Class AbstractClassProcessor

java.lang.Object

org.eclipse.xtend.lib.macro.AbstractClassProcessor

All Implemented Interfaces:

CodeGenerationParticipant<ClassDeclaration>, RegisterGlobalsParticipant<ClassDeclaration>, TransformationParticipant<MutableClassDeclaration>, ValidationParticipant<ClassDeclaration>

Direct Known Subclasses:

DataProcessor, DataProcessor, EqualsHashCodeProcessor, ToStringProcessor

@Beta
public abstract class AbstractClassProcessor
extends java.lang.Object
implements RegisterGlobalsParticipant<ClassDeclaration>, TransformationParticipant<MutableClassDeclaration>, CodeGenerationParticipant<ClassDeclaration>, ValidationParticipant<ClassDeclaration>

A convenient base class to process active annotations for classes.

Author:

Sven Efftinge

Constructor Summary

Constructors

Constructor and Description
AbstractClassProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	doGenerateCode(ClassDeclaration annotatedClass, CodeGenerationContext context) Called during code generation.
void	doGenerateCode(java.util.List<? extends ClassDeclaration> annotatedSourceElements, CodeGenerationContext context) Invoked by the compiler during the code generation phase.
void	doRegisterGlobals(ClassDeclaration annotatedClass, RegisterGlobalsContext context) Called during global symbol collecting.
void	doRegisterGlobals(java.util.List<? extends ClassDeclaration> annotatedClasses, RegisterGlobalsContext context) Called by the compiler during register-globals phase.
void	doTransform(java.util.List<? extends MutableClassDeclaration> annotatedClasses, TransformationContext context) Invoked by the compiler
void	doTransform(MutableClassDeclaration annotatedClass, TransformationContext context)
void	doValidate(ClassDeclaration annotatedClass, ValidationContext context) Invoked by the validator
void	doValidate(java.util.List<? extends ClassDeclaration> annotatedClasses, 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

AbstractClassProcessor

public AbstractClassProcessor()

Method Detail

doRegisterGlobals

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

Description copied from interface: RegisterGlobalsParticipant

Called by the compiler during register-globals phase.

Specified by:

doRegisterGlobals in interface RegisterGlobalsParticipant<ClassDeclaration>

Parameters:

annotatedClasses - 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(ClassDeclaration annotatedClass,
                     @Extension
                     RegisterGlobalsContext context)

Called during global symbol collecting.

Parameters:

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

context -

doTransform

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

Description copied from interface: TransformationParticipant

Invoked by the compiler

Specified by:

doTransform in interface TransformationParticipant<MutableClassDeclaration>

Parameters:

annotatedClasses - the mutable java representation of the annotated elements

context - a TransformationContext providing useful services.

doTransform

public void doTransform(MutableClassDeclaration annotatedClass,
               @Extension
               TransformationContext context)

Parameters:

annotatedClass - a mutable class representation annotated with the annotation this processor is responsible for.

context -

doGenerateCode

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

Description copied from interface: CodeGenerationParticipant

Invoked by the compiler during the code generation phase.

Specified by:

doGenerateCode in interface CodeGenerationParticipant<ClassDeclaration>

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(ClassDeclaration annotatedClass,
                  @Extension
                  CodeGenerationContext context)

Called during code generation.

Parameters:

annotatedClass - 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 ClassDeclaration> annotatedClasses,
              @Extension
              ValidationContext context)

Description copied from interface: ValidationParticipant

Invoked by the validator

Specified by:

doValidate in interface ValidationParticipant<ClassDeclaration>

Parameters:

annotatedClasses - the java representation of the annotated elements

context - a ValidationContext providing useful services.

doValidate

public void doValidate(ClassDeclaration annotatedClass,
              @Extension
              ValidationContext context)

Invoked by the validator

Parameters:

annotatedClass - the generated class that should be validated

context -

Since:

2.7

See Also:

doValidate(List, ValidationContext)