com.gwtplatform.dispatch.annotation.helper

Class ClassGenerationHelper

java.lang.Object

com.gwtplatform.dispatch.annotation.helper.GenerationHelper

com.gwtplatform.dispatch.annotation.helper.ClassGenerationHelper

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BuilderGenerationHelper

public class ClassGenerationHelper
extends GenerationHelper

ClassGenerationHelper is an internal class that provides common routines only used by the annotation processors.

Author:

Brendan Doherty, Florian Sauter, Stephen Haberman (concept)

Constructor Summary

Constructors

Constructor and Description
ClassGenerationHelper(Writer sourceWriter)

Method Summary

Methods

Modifier and Type	Method and Description
void	generateClassHeader(String className, String extendedClassName, Set<Modifier> modifiers, String... extraInterfaces) Generates a class header.
void	generateConstructorUsingFields(String simpleClassName, Collection<VariableElement> fieldsToBePassedAndAssigned, Modifier... constructorModifiers)
void	generateEmptyConstructor(String simpleClassName, Modifier modifier)
void	generateEquals(String simpleClassName, Collection<VariableElement> fieldElements) Creates an equals method using Java standards.
void	generateFieldAccessors(Collection<VariableElement> fieldElements)
void	generateFieldAssignment(VariableElement fieldElement, Object value) Creates a default field assignment.
void	generateHashCode(Collection<VariableElement> fieldElements) Creates an hashCode method using Java standards.
void	generateToString(String simpleClassName, Collection<VariableElement> fieldElements)

Methods inherited from class com.gwtplatform.dispatch.annotation.helper.GenerationHelper

close, determineFinalConstantValue, determineWrapperClass, firstCharToUpperCase, generateAnnotation, generateConstantFieldDeclaration, generateFieldDeclaration, generateFieldDeclaration, generateFieldDeclarations, generateFieldList, generateFooter, generateImports, generateImports, generateModifierList, generatePackageDeclaration, implode, isConstant, isFinal, isPrimitive, isStatic, manufactureAccessorName, manufactureField, manufactureIndentation, manufactureSetterName, manufactureSetterName, print, print, println, println, println, printWithoutSpaces, replaceParameters, resetWhitespaces, setWhitespaces

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassGenerationHelper

public ClassGenerationHelper(Writer sourceWriter)

Method Detail

generateClassHeader

public void generateClassHeader(String className,
                       String extendedClassName,
                       Set<Modifier> modifiers,
                       String... extraInterfaces)

Generates a class header. Pass null to skip the parent class.

Usage:

 
  generateClassHeader(Foo.class.getSimpleName(),
        HasName.class.getSimpleName,
        "MyGenericInterface<Foo>"
  )
  
 

Generated example:

 public class MyFoo extends Foo implements HasName, MyGenericInterface<Foo> {

Parameters:

className - the simple class name

modifiers - the modifiers for the class

extendedClassName - the parent class name

extraInterfaces - array of interface names to be implemented

generateConstructorUsingFields

public void generateConstructorUsingFields(String simpleClassName,
                                  Collection<VariableElement> fieldsToBePassedAndAssigned,
                                  Modifier... constructorModifiers)

generateEmptyConstructor

public void generateEmptyConstructor(String simpleClassName,
                            Modifier modifier)

generateEquals

public void generateEquals(String simpleClassName,
                  Collection<VariableElement> fieldElements)

Creates an equals method using Java standards.

Parameters:

simpleClassName - the class name

fieldElements - the field elements

generateFieldAccessors

public void generateFieldAccessors(Collection<VariableElement> fieldElements)

generateFieldAssignment

public void generateFieldAssignment(VariableElement fieldElement,
                           Object value)

Creates a default field assignment.

generateFieldAssignment(myNameIsTest, null)

Generates:

this.test = null;

Parameters:

fieldElement -

value -

generateHashCode

public void generateHashCode(Collection<VariableElement> fieldElements)

Creates an hashCode method using Java standards.

Parameters:

fieldElements - the field elements

generateToString

public void generateToString(String simpleClassName,
                    Collection<VariableElement> fieldElements)